Authentifizierung
Alles über API-Keys, Rate Limits und Sicherheit bei der Northly API.
Bearer-Token-Authentifizierung
Alle API-Requests werden mit Bearer-Token authentifiziert.
Senden Sie Ihren API-Key als Bearer-Token im Authorization-Header jedes Requests. Alle Anfragen müssen über HTTPS erfolgen.
curl -X GET "https://api.northlyapp.com/v1/objectives" \
-H "Authorization: Bearer nly_live_abc123def456..."API-Key-Verwaltung
Erstellen und verwalten Sie Ihre API-Keys sicher.
- Erstellen Sie API-Keys in den Northly-Einstellungen unter „API-Keys“.
- Jeder Key kann mit einem Namen und optionalen Berechtigungen versehen werden.
- Widerrufen Sie einen Key sofort, wenn er kompromittiert wurde.
- API-Zugang erfordert mindestens den Business-Tarif.
Rate Limits
Die API ist auf eine bestimmte Anzahl von Anfragen pro Stunde begrenzt.
| Tarif | Limit |
|---|---|
| Business | 1,000 Anfragen/Stunde |
| Enterprise | 5,000 Anfragen/Stunde |
Rate-Limit-Informationen werden in den Response-Headern zurückgegeben:
HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 997
X-RateLimit-Reset: 1709985600Fehlercodes
Die API verwendet standardmäßige HTTP-Statuscodes.
| Code | Name | Beschreibung |
|---|---|---|
400 | Bad Request | Die Anfrage war ungültig oder fehlerhaft. |
401 | Unauthorized | Fehlender oder ungültiger API-Key. |
403 | Forbidden | Keine Berechtigung für diese Aktion. |
404 | Not Found | Die angeforderte Ressource wurde nicht gefunden. |
422 | Unprocessable Entity | Validierungsfehler in den Eingabedaten. |
429 | Too Many Requests | Rate Limit überschritten. Versuchen Sie es später erneut. |
500 | Internal Server Error | Ein unerwarteter Fehler ist aufgetreten. |
400Bad RequestDie Anfrage war ungültig oder fehlerhaft.
401UnauthorizedFehlender oder ungültiger API-Key.
403ForbiddenKeine Berechtigung für diese Aktion.
404Not FoundDie angeforderte Ressource wurde nicht gefunden.
422Unprocessable EntityValidierungsfehler in den Eingabedaten.
429Too Many RequestsRate Limit überschritten. Versuchen Sie es später erneut.
500Internal Server ErrorEin unerwarteter Fehler ist aufgetreten.
Beispiel-Fehlerantwort:
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key",
"status": 401
}
}Sicherheitsempfehlungen
Best Practices für den sicheren Umgang mit API-Keys.
- Speichern Sie API-Keys niemals im Quellcode oder in öffentlichen Repositories.
- Verwenden Sie Umgebungsvariablen oder einen Secret Manager.
- Rotieren Sie API-Keys regelmäßig.
- Verwenden Sie für jeden Service einen eigenen API-Key.
- Alle API-Anfragen müssen über HTTPS erfolgen – HTTP wird abgelehnt.