Die REST-Api ist unter https://homeworker.li/api/v2 erreichbar.
Um einen gültigen Access-Token für einen Benutzer zu erhalten, muss sich der Benutzer mit einer OAuth2-Anwendung authorisieren. Mehr steht dazu unter Autorisierung von OAuth-Apps.
Alle Anfragen müssen einen validen oAuth2 Access-Token im Authorization-Header senden.
z.B. Authorization: Bearer [access-token]
Verschiedene Anwendungen sollten sich identizfieren. Der Header ist bisher optional, jedoch behalten wir uns das Recht vor Anfragen abzulehnen, welche von einem bösartigen Client stammen.
Hierfür wird der Header X-Client verwendet.
z.B. X-Client: homeworker-web alpha-0.0.1
Von einer IP-Adresse können max. 300 Anfragen pro Minute gesendet werden.
Die Zurückgegebenen HTTP-Header zeigen den aktuellen Status der Rate-Limit Regeln.
| Header-Feld | Beschreibung |
|---|---|
X-RateLimit-Limit |
Die maximale Anzahl an Fragen, die pro Minute gestellt werden darf. |
X-RateLimit-Remaining |
Die Anzahl an Fragen, die noch für die aktuelle Minute gestellt werden dürfen. |
X-RateLimit-Reset |
UNIX Epoch-Timestamp ab wann das Fenster für die Rate-Limits wieder zurückgesetzt wird. |
curl -i https://homeworker.li/api/v2/ips
HTTP/1.1 200 OK
Status: 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 244
X-RateLimit-Reset: 1589840940