RESTful API Interface
- Online API Status
- 1 API Version
- https://armasquads.com/api/v1 API Endpoint
API Calls are currently limited with 100 Requests/per Hour. If you are interested into make more calls ping me by mail.
E-Mail: ins0@racecore.de
E-Mail: ins0@racecore.de
Your API Key
API Authentication
To Authenticate with the API and send commands you need to send a specific Header on every request against the API.
Example:
POST /api/v1/ HTTP/1.1
Host: x.x.x.x
User-Agent: MyAwesomeApplication/v1
X-API-Key: [YOUR_API_KEY]
Content-Type: application/x-www-form-urlencoded
[data]
Alternatively add
Example:
X-API-Key:[YOUR_API_KEY]Example:
POST /api/v1/ HTTP/1.1
Host: x.x.x.x
User-Agent: MyAwesomeApplication/v1
X-API-Key: [YOUR_API_KEY]
Content-Type: application/x-www-form-urlencoded
[data]
Alternatively add
?key=[YOUR_API_KEY] to the request url to authenticate. *not recommended*Example:
https://armasquads.com/api/v1/squads?key=YOUR_API_KEY
Send POST/PUT Data
Sending Data to the API need to format as valid JSON
{ "keyName": "value", [...] }
{ "keyName": "value", [...] }
Squad Image Format
Sending a Squad Image requires the Image Data converted to Base64
{ "logo": "iVBORw0KGgoAA[...]" }
{ "logo": "iVBORw0KGgoAA[...]" }
REST API Commands/Resources
Squads
Create a new Squad POST /squads
| Name | DataType | Required | Example | Description |
| tag | string | "tag": "AS" |
Squad Tag | |
| name | string | "name": "Awesome Squad" |
Squad Name | |
| string | "email": "example@example.com" |
Squad Email | ||
| logo | base64 string | "logo": "iVBORw0KGgoAA[...]" |
Squad Logo in Base64 Format | |
| homepage | string | "homepage": "http://example.com" |
Squad Homepage | |
| title | string | "title": "We are Awesome" |
Squad Tag |
Example POST:
/squads
{
"tag": "AS",
"name": "Awesome Squad",
"email": "example@example.com",
"logo": "iVBORw0KGgoAA[...]",
"homepage": "http://example.com",
"title": "We are Awesome"
}
Get all user squads GET /squads
Example GET:
/squads
Get specific user squad by ID GET /squads/[id]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456 |
URL Parameter (Squad ID) |
Example GET:
/squads/123456
Update specific squad data by ID PUT /squads/[id]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456 |
URL Parameter (Squad ID) | |
| tag | string | "tag": "AS" |
Squad Tag | |
| name | string | "name": "Awesome Squad" |
Squad Name | |
| string | "email": "example@example.com" |
Squad Email | ||
| logo | base64 string | "logo": "iVBORw0KGgoAA[...]" |
Squad Logo in Base64 Format | |
| homepage | string | "homepage": "http://example.com" |
Squad Homepage | |
| title | string | "title": "We are Awesome" |
Squad Tag |
Example PUT:
/squads/123456
{
"tag": "AS",
"name": "Awesome Squad",
"email": "example@example.com",
"logo": "iVBORw0KGgoAA[...]",
"homepage": "http://example.com",
"title": "We are Awesome"
}
Delete a specific user squad by ID DELETE /squads/[id]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456 |
URL Parameter (Squad ID) |
Example DELETE:
/squads/123456
Members
Create a new Squad Member POST /squads/[id]/members
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456/members |
URL Parameter (Squad ID) | |
| uuid | mixed | "uuid": "123456789" |
ARMA Player UUID | |
| username | string | "username": "TBone" |
ARMA Player Username | |
| name | string | "name": "Tommy Awesome" |
Member Name | |
| string | "email": "example@example.com" |
Member Email Address | ||
| icq | string | "icq": "123456789" |
Member ICQ UIN | |
| remark | string | "remark": "He is Awesome!" |
Member Remark |
Example POST:
/squads/123456/members
{
"uuid": "123456789",
"username": "TBone",
"name": "Tommy Awesome",
"email": "example@example.com",
"icq": "123456789",
"remark": "He is Awesome!"
}
Get all members from specific squad GET /squads/[id]/members
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456/members |
URL Parameter (Squad ID) |
Example GET:
/squads/123456/members
Return specific member data from UUID GET /squads/[id]/members/[uuid]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456/members |
URL Parameter (Squad ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL Parameter (Member UUID) |
Example GET:
/squads/123456/members/123456789
Update a Squad Member Data PUT /squads/[id]/members/[uuid]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456/members |
URL Parameter (Squad ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL Parameter (Member UUID) | |
| uuid | mixed | "uuid": "123456789" |
ARMA Player UUID | |
| username | string | "username": "TBone" |
ARMA Player Username | |
| name | string | "name": "Tommy Awesome" |
Member Name | |
| string | "email": "example@example.com" |
Member Email Address | ||
| icq | string | "icq": "123456789" |
Member ICQ UIN | |
| remark | string | "remark": "He is Awesome!" |
Member Remark |
Example PUT:
/squads/123456/members/123456789
{
"uuid": "123456789",
"username": "TBone",
"name": "Tommy Awesome",
"email": "example@example.com",
"icq": "123456789",
"remark": "He is Awesome!"
}
Delete a specific member from squad DELETE /squads/[id]/members/[uuid]
| Name | DataType | Required | Example | Description |
| [id] | integer | /squads/123456/members |
URL Parameter (Squad ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL Parameter (Member UUID) |
Example DELETE:
/squads/123456/members/123456789