Zum Hauptinhalt springen

Schnellstart mit Firmium

Willkommen bei Firmium! Diese Anleitung führt Sie Schritt für Schritt durch die ersten Schritte, von der Registrierung bis zur ersten erfolgreichen API-Anfrage.

1. Registrierung

  1. Besuchen Sie das Firmium Dashboard.
  2. Erstellen Sie ein neues Benutzerkonto mit Ihrer E-Mail-Adresse.
  3. Bestätigen Sie Ihre E-Mail-Adresse über den zugesandten Link.

2. API-Key erhalten

  1. Melden Sie sich im Dashboard an.
  2. Navigieren Sie zu API / Schnittstelle.
  3. Erstellen Sie einen neuen API-Key und kopieren Sie ihn sicher. Der vollständige Key wird nur einmal angezeigt.
Hinweis: Behandeln Sie Ihren API-Key wie ein Passwort. Geben Sie ihn nicht weiter und speichern Sie ihn sicher.

3. Erste API-Anfrage

Verwenden Sie Ihren API-Key, um eine Anfrage an die Firmium-API zu stellen. Beispiel mit curl:

Unternehmen suchen

Antwortbeispiel:
Mit der zurückgegebenen uuid rufen Sie das Unternehmensprofil ab:

4. Fehlerbehandlung

  • 403 Forbidden: Key fehlt, ist ungültig oder widerrufen, oder Ihr Tarif enthält keinen API-Zugriff.
  • 400 Bad Request: Ungültige Suchparameter.
Tipp: Prüfen Sie bei Fehlern immer die Gültigkeit Ihres Keys und Ihre Zugriffsrechte im Dashboard.

5. Best Practices

  • Speichern Sie Ihren API-Key niemals im Quellcode oder in öffentlichen Repositories.
  • Rotieren Sie API-Keys regelmäßig und löschen Sie nicht mehr benötigte Keys.
  • Beachten Sie die Rate Limits der API.
  • Lesen Sie die Authentifizierungsdokumentation für Details zur sicheren Nutzung.

Nächste Schritte