Zum Hauptinhalt springen

Create New API Key

POST 
/company/apikey/

Erstelle einen neuen API-Schlüssel für den authentifizierten Benutzer, der mit seinem Unternehmen verknüpft ist, um programmatische Authentifizierung für externe Integrationen und Automatisierungen zu ermöglichen.

Ziel​

Sichere Zugangsdaten vom Typ API-Schlüssel generieren, die programmatischen Zugriff auf die Ressourcen des Unternehmens gemäß dem angegebenen Berechtigungstyp ermöglichen.

Anwendungsfälle​

  • Integration mit externen Transportmanagementsystemen
  • Automatisierung der Auktionserstellung durch Skripte
  • Automatische Rechnungserstellung aus Drittanbieterplattformen
  • Entwicklung von benutzerdefinierten Anwendungen, die die CargoOffer-API nutzen

Limits​

  • Maximal 4 API-Schlüssel pro Unternehmen
  • Bei Erreichen des Limits wird ein Fehler 403 mit dem Code MAX_APIKEYS zurückgegeben
  • Jeder Schlüssel ist einzigartig und kann nach der Erstellung nicht wiederhergestellt werden

Ablauf​

flowchart TD
  A[Anfrage empfangen] --> B{Benutzer authentifiziert?}
  B -->|Nein| C[401 Unauthorized]
  B -->|Ja| D{Benutzer existiert?}
  D -->|Nein| E[404 USER_NOT_FOUND]
  D -->|Ja| F{Unternehmen existiert?}
  F -->|Nein| G[404 COMPANY_NOT_FOUND]
  F -->|Ja| H{API-Schlüssel < 4?}
  H -->|Nein| I[403 MAX_APIKEYS]
  H -->|Ja| J{Typ gültig?}
  J -->|Nein| K[400 Mongoose-Validierung]
  J -->|Ja| L[Schlüssel generieren (40 Zeichen)]
  L --> M[temp_code generieren]
  M --> N[In Datenbank speichern]
  N --> O[201 Created + Vollständiger Schlüssel]

Wichtige Hinweise​

  • Der API-Schlüssel wird nur im Moment der Erstellung vollständig angezeigt
  • Er kann später nicht wiederhergestellt werden und muss sicher gespeichert werden

Request​

Responses​

API-Schlüssel erfolgreich erstellt

Response Headers