Einführung

Dieser Leitfaden bietet einen Überblick darüber, wie Sie mit unserer API beginnen können.

Base-URL

Alle API-Anfragen sollten an die folgende Base-URL gerichtet werden:

https://api.pvnode.com/v1/

Wir erzwingen HTTPS für alle API-Anfragen, um die Sicherheit und Integrität der Daten zu gewährleisten, die zwischen Ihrer Anwendung und unseren Servern übertragen werden.

Authentifizierung

Derzeit bieten wir API-Key-Authentifizierung an. JWT (JSON Web Token) Authentifizierung ist für zukünftige Versionen geplant und wird hier dokumentiert, sobald sie verfügbar ist.

API Keys

Um Ihre Anfragen zu authentifizieren, müssen Sie Ihren API-Key im Authorization-Header jeder Anfrage einfügen.

• API-Key erstellen (oder lesen Sie unseren Leitfaden Einen API-Key erhalten)

Der Authorization-Header sollte wie folgt formatiert sein:

Authorization: Bearer YOUR_API_KEY

Ersetzen Sie YOUR_API_KEY mit dem Ihrem tatsächlichen API-Key.

Antwort Codes

Unsere API verwendet Standard HTTP-Statuscodes, um den Erfolg oder Fehler Ihrer Anfragen anzuzeigen. Hier sind einige der häufigsten Codes, denen Sie begegnen könnten:

• 200 OK: Die Anfrage war erfolgreich.
• 400 Bad Request: Die Anfrage war fehlerhaft oder ungültig. Dies bedeutet normalerweise, dass ein Problem mit den Daten vorliegt, die Sie im Body Ihrer gesendet haben. Bitte überprüfen Sie die API-Dokumentation auf das korrekte Format.
• 401 Unauthorized: Der Anfrage fehlten gültige Authentifizierungsdaten. Dies bedeutet normalerweise, dass Ihr API-Key fehlt oder ungültig ist.
• 403 Forbidden: Der Server hat die Anfrage verstanden, verweigert aber die Autorisierung. Dies kann passieren, wenn Sie versuchen, auf eine Ressource zuzugreifen, für die Sie keine Berechtigung haben.
• 404 Not Found: Die angeforderte Ressource konnte nicht gefunden werden. Dies könnte auf eine falsche URL hinweisen oder darauf, dass die Ressource gelöscht wurde.
• 429 Too Many Requests: Sie haben zu viele Anfragen in einer bestimmten Zeit gesendet. Bitte warten Sie und versuchen Sie es erneut.
• 5XX Server Error: Diese Codes weisen auf einen Fehler auf unserer Seite (den pvnode-Servern) hin. Wenn Sie einen 5XX-Fehler erhalten, versuchen Sie Ihre Anfrage bitte später erneut. Wenn das Problem weiterhin besteht, kontaktieren Sie bitte unser Support-Team.

Rate Limiting

Um optimale Performance und faire Nutzung für alle User sicherzustellen, verwendet unsere API Rate Limiting. Das bedeutet, dass es ein Limit für die Anzahl der Requests gibt, die innerhalb eines bestimmten Zeitraums gestellt werden können.

Rate Limits werden pro Endpoint angewendet. Die spezifischen Rate Limits für jeden Endpoint finden Sie in der API Referenz Dokumentation.

Wenn Sie das Rate Limit für einen Endpoint überschreiten, erhalten Sie einen 429 Too Many Requests Response Code. Bitte warten Sie, bevor Sie weitere Requests an diesen Endpoint senden.