Einführung
Alles, was Sie benötigen, um die Piloterr API in Ihre Anwendung zu integrieren.
Starten Sie mit der Piloterr API in wenigen Minuten. Senden Sie HTTP-Anfragen an unsere Endpunkte und erhalten Sie strukturierte JSON-Antworten.
Schnellstart
Holen Sie sich Ihren API-Schlüssel
Registrieren Sie sich in Ihrem Dashboard und kopieren Sie Ihren API-Schlüssel von der Einstellungen-Seite.
Stellen Sie Ihre erste Anfrage
Fügen Sie Ihren Schlüssel in den x-api-key-Header ein und rufen Sie einen beliebigen Endpunkt auf:
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Verarbeiten Sie die Antwort
Jede erfolgreiche Anfrage gibt ein JSON-Objekt mit strukturierten Daten zurück. Sehen Sie sich die einzelnen Endpunkt-Seiten für Antwortschemata und Beispiele an.
Authentifizierung
Alle API-Anfragen müssen einen x-api-key-Header enthalten. Ihren Schlüssel finden Sie in Ihrem Dashboard > API-Schlüssel.
curl -H "x-api-key: xxxx" https://api.piloterr.com/v2/usageHalten Sie Ihren API-Schlüssel geheim. Exponieren Sie ihn nicht in clientseitigem Code oder öffentlichen Repositories.
Statuscodes
Die Abrechnung gilt für erfolgreiche Anfragen: 200 für synchrone Aufrufe, 201 für asynchrone Jobs. Die 404-Abrechnung variiert je nach Endpunkt (siehe jeweilige Endpunkt-Seite). Alle anderen 4xx/5xx-Antworten sind kostenlos.
| Code | Abgerechnet | Status | Aktion |
|---|---|---|---|
200 | Ja | Erfolgreicher API-Aufruf | Keine Aktion erforderlich. |
201 | Ja | Job erstellt | Keine Aktion erforderlich. |
202 | Nein | Akzeptiert (asynchron) | Die Anfrage wurde akzeptiert und wird verarbeitet. Verwenden Sie die Job-ID, um den Status zu prüfen. |
400 | Nein | Ungültige Anfrage | Überprüfen Sie Ihre Parameter und deren Typen. Weitere Informationen finden Sie in der Dokumentation. |
401 | Nein | Ungültiger API-Schlüssel | Überprüfen Sie Ihren API-Schlüssel (x-api-key-Header oder x_api_key-Abfragestring). |
401 | Nein | Inaktiver API-Schlüssel | Aktivieren Sie Ihren API-Schlüssel im Abschnitt API-Schlüssel Ihrer Kontoeinstellungen. |
401 | Nein | Abgelaufener API-Schlüssel | Aktualisieren Sie Ihren API-Schlüssel oder generieren Sie einen neuen. |
401 | Nein | Rate limit exceeded | Warten und erneut versuchen. Plan upgraden oder schlüsselbezogene Kontingente erhöhen, wenn dies häufig vorkommt. |
402 | Nein | Payment required | Credits aufladen, Plan upgraden, Automatische Aufladung aktivieren oder offene Rechnungen begleichen. |
403 | Nein | Verboten | Überprüfen Sie Ihre Berechtigungen. Kontaktieren Sie uns, wenn Sie der Meinung sind, dass dies ein Fehler ist. |
404 | Variiert | Nicht gefunden | Die Abrechnung ist endpunktspezifisch. Überprüfen Sie die Dokumentation des jeweiligen Endpunkts. |
413 | Nein | Nutzlast zu groß | Die hochgeladene Datei oder der Anfragekörper überschreitet das Größenlimit. Weitere Informationen finden Sie in der Dokumentation. |
500 | Nein | Interner Fehler | Wiederholen Sie die Aktion oder kontaktieren Sie unser Support-Team. |
Weitere Informationen finden Sie auf der Seite Guthaben für eine vollständige Aufschlüsselung pro Endpunkt, API-Schlüssel für die Schlüsselverwaltung sowie Best Practices und Fehlerbehandlung für Integrationsleitlinien. Neu auf der Plattform? Das Glossar erklärt alle wichtigen Begriffe.
Endpunkte
Öffnen Sie jeden Endpunkt in der API-Referenz, oder springen Sie direkt dorthin: