REST-API-Schnittstelle
- Online API-Status
- 1 API-Version
- https://armasquads.com/api/v1 API-Endpunkt
API-Aufrufe sind derzeit auf 100 Anfragen pro Stunde begrenzt. Wenn du mehr brauchst, schreib mir eine Mail.
E-Mail: ins0@racecore.de
E-Mail: ins0@racecore.de
Dein API-Key
Anmeldung an der API
Um dich an der API anzumelden und Befehle zu senden, musst du bei jeder Anfrage einen bestimmten Header mitschicken.
Beispiel:
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]
Alternativ kannst du zur Anmeldung
Beispiel:
X-API-Key:[YOUR_API_KEY]Beispiel:
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]
Alternativ kannst du zur Anmeldung
?key=[YOUR_API_KEY] an die URL der Anfrage hängen. *nicht empfohlen*Beispiel:
https://armasquads.com/api/v1/squads?key=YOUR_API_KEY
POST/PUT-Daten senden
Daten an die API müssen als gültiges JSON gesendet werden
{ "keyName": "value", [...] }
{ "keyName": "value", [...] }
Format des Squad-Bilds
Für ein Squad-Bild müssen die Bilddaten Base64-kodiert gesendet werden
{ "logo": "iVBORw0KGgoAA[...]" }
{ "logo": "iVBORw0KGgoAA[...]" }
REST-API-Befehle und Ressourcen
Squads
Neuen Squad anlegen POST /squads
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| tag | string | "tag": "AS" |
Squad-Tag | |
| name | string | "name": "Awesome Squad" |
Squad-Name | |
| string | "email": "example@example.com" |
Squad-E-Mail | ||
| logo | base64 string | "logo": "iVBORw0KGgoAA[...]" |
Squad-Logo im Base64-Format | |
| homepage | string | "homepage": "http://example.com" |
Squad-Homepage | |
| title | string | "title": "We are Awesome" |
Squad-Tag |
Beispiel POST:
/squads
{
"tag": "AS",
"name": "Awesome Squad",
"email": "example@example.com",
"logo": "iVBORw0KGgoAA[...]",
"homepage": "http://example.com",
"title": "We are Awesome"
}
Alle Squads des Nutzers abrufen GET /squads
Beispiel GET:
/squads
Einen Squad des Nutzers über die ID abrufen GET /squads/[id]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456 |
URL-Parameter (Squad-ID) |
Beispiel GET:
/squads/123456
Daten eines Squads über die ID ändern PUT /squads/[id]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [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-E-Mail | ||
| logo | base64 string | "logo": "iVBORw0KGgoAA[...]" |
Squad-Logo im Base64-Format | |
| homepage | string | "homepage": "http://example.com" |
Squad-Homepage | |
| title | string | "title": "We are Awesome" |
Squad-Tag |
Beispiel PUT:
/squads/123456
{
"tag": "AS",
"name": "Awesome Squad",
"email": "example@example.com",
"logo": "iVBORw0KGgoAA[...]",
"homepage": "http://example.com",
"title": "We are Awesome"
}
Einen Squad des Nutzers über die ID löschen DELETE /squads/[id]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456 |
URL-Parameter (Squad-ID) |
Beispiel DELETE:
/squads/123456
Mitglieder
Neues Squad-Mitglied anlegen POST /squads/[id]/members
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456/members |
URL-Parameter (Squad-ID) | |
| uuid | mixed | "uuid": "123456789" |
UUID des ARMA-Spielers | |
| username | string | "username": "TBone" |
Spielername in ARMA | |
| name | string | "name": "Tommy Awesome" |
Name des Mitglieds | |
| string | "email": "example@example.com" |
E-Mail-Adresse des Mitglieds | ||
| icq | string | "icq": "123456789" |
ICQ-UIN des Mitglieds | |
| remark | string | "remark": "He is Awesome!" |
Bemerkung zum Mitglied |
Beispiel POST:
/squads/123456/members
{
"uuid": "123456789",
"username": "TBone",
"name": "Tommy Awesome",
"email": "example@example.com",
"icq": "123456789",
"remark": "He is Awesome!"
}
Alle Mitglieder eines Squads abrufen GET /squads/[id]/members
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456/members |
URL-Parameter (Squad-ID) |
Beispiel GET:
/squads/123456/members
Daten eines Mitglieds über die UUID abrufen GET /squads/[id]/members/[uuid]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456/members |
URL-Parameter (Squad-ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL-Parameter (UUID des Mitglieds) |
Beispiel GET:
/squads/123456/members/123456789
Daten eines Squad-Mitglieds ändern PUT /squads/[id]/members/[uuid]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456/members |
URL-Parameter (Squad-ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL-Parameter (UUID des Mitglieds) | |
| uuid | mixed | "uuid": "123456789" |
UUID des ARMA-Spielers | |
| username | string | "username": "TBone" |
Spielername in ARMA | |
| name | string | "name": "Tommy Awesome" |
Name des Mitglieds | |
| string | "email": "example@example.com" |
E-Mail-Adresse des Mitglieds | ||
| icq | string | "icq": "123456789" |
ICQ-UIN des Mitglieds | |
| remark | string | "remark": "He is Awesome!" |
Bemerkung zum Mitglied |
Beispiel PUT:
/squads/123456/members/123456789
{
"uuid": "123456789",
"username": "TBone",
"name": "Tommy Awesome",
"email": "example@example.com",
"icq": "123456789",
"remark": "He is Awesome!"
}
Ein Mitglied aus dem Squad löschen DELETE /squads/[id]/members/[uuid]
| Name | Datentyp | Pflicht | Beispiel | Beschreibung |
| [id] | integer | /squads/123456/members |
URL-Parameter (Squad-ID) | |
| [uuid] | mixed | /squads/123456/members/123456789 |
URL-Parameter (UUID des Mitglieds) |
Beispiel DELETE:
/squads/123456/members/123456789