​

Authentifizierung

​

Erste Schritte

1. Erstellen Sie Ihren API-Key im Firmium-Dashboard unter API / Schnittstelle. Der vollständige Key wird nur einmal bei der Erstellung angezeigt.
2. Fügen Sie den Key Ihren API-Anfragen hinzu.
3. Zum Widerrufen löschen Sie den Key im selben Dashboard-Bereich. Gelöschte Keys funktionieren sofort nicht mehr.

​

Authentifizierungs-Header

Authorization: Token <ihr_api_key>

Hinweis: Das Schema lautet Token, nicht Bearer.

​

Key-Format

• Der Key ist eine undurchsichtige Zeichenkette, die von Firmium bereitgestellt wird.
• Firmium speichert nur einen Hash des Keys und kann ihn nicht erneut anzeigen.
• Behandeln Sie Ihren Key wie ein Passwort: Bewahren Sie ihn sicher auf und geben Sie ihn nicht weiter.
• Der API-Zugriff hängt von Ihrem Tarif ab. Anfragen mit einem Key aus einem Tarif ohne API-Zugriff werden abgelehnt.

​

Beispielanfrage

curl -X POST https://www.firmium.de/api/v1/companies/search/ \
  -H "Authorization: Token <ihr_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Beispiel GmbH"}'

​

Fehlermeldungen

{
  "detail": "Invalid token"
}

​

Best Practices

1. Sichere Speicherung: Bewahren Sie Keys sicher auf und committen Sie sie niemals in die Versionskontrolle.
2. Rotation: Rotieren Sie Ihre Keys regelmäßig und löschen Sie nicht mehr benötigte Keys.
3. Fehlerbehandlung: Behandeln Sie 403 explizit.
4. Rate Limiting: Beachten Sie die Rate Limits und implementieren Sie geeignete Backoff-Strategien.

​

Nächste Schritte

• Mehr über Rate Limits erfahren
• Fehlercodes entdecken