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 (Bearer-Token) und kopieren Sie ihn sicher.
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

curl -X POST https://www.firmium.de/api/v1/companies/search/ \
  -H "Authorization: Bearer Ihr_API_Token" \
  -H "Content-Type: application/json" \
  -d '{"name": "Beispiel GmbH"}'
Antwortbeispiel: 
[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Beispiel GmbH",
    "registration_number": "FN 123456a",
    "status": "active",
    "legal_form": "GmbH"
  }
]

​
Deep Search für umfassende Ergebnisse

curl -X POST https://www.firmium.de/api/v1/companies/search/ \
  -H "Authorization: Bearer Ihr_API_Token" \
  -H "Content-Type: application/json" \
  -d '{"name": "Beispiel GmbH", "deep": true}'

​
4. Fehlerbehandlung

  • 401 Unauthorized: Token fehlt, ist ungültig oder abgelaufen.
  • 403 Forbidden: Unzureichende Berechtigungen für die angeforderte Ressource.
Tipp: Prüfen Sie bei Fehlern immer die Gültigkeit Ihres Tokens 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

⌘I