Passa al contenuto principale

Create New API Key

POST 
/company/apikey/

Crea una nuova API Key per l'utente autenticato associata alla sua azienda, consentendo l'autenticazione programmatica per integrazioni esterne e automazioni.

Obiettivo​

Generare credenziali sicure di tipo API Key che consentano l'accesso programmatico alle risorse dell'azienda in base al tipo di permessi specificato.

Casi d'Uso​

  • Integrazione con sistemi esterni di gestione del trasporto
  • Automazione della creazione di aste tramite script
  • Generazione automatica di fatture da piattaforme di terze parti
  • Sviluppo di applicazioni personalizzate che consumano l'API di CargoOffer

Limiti​

  • Massimo 4 API Key per azienda
  • Se viene raggiunto il limite, verrà restituito l'errore 403 con codice MAX_APIKEYS
  • Ogni key è unica e irrecuperabile una volta creata

Flusso operativo​

flowchart TD
  A[Ricevi Richiesta] --> B{Utente Autenticato?}
  B -->|No| C[401 Unauthorized]
  B -->|Sì| D{Utente Esiste?}
  D -->|No| E[404 USER_NOT_FOUND]
  D -->|Sì| F{Azienda Esiste?}
  F -->|No| G[404 COMPANY_NOT_FOUND]
  F -->|Sì| H{API Keys < 4?}
  H -->|No| I[403 MAX_APIKEYS]
  H -->|Sì| J{Tipo Valido?}
  J -->|No| K[400 Validazione Mongoose]
  J -->|Sì| L[Genera Key 40 caratteri]
  L --> M[Genera temp_code]
  M --> N[Salva nel DB]
  N --> O[201 Created + Key Completa]

Considerazioni importanti​

  • L'API Key viene mostrata completa solo al momento della creazione
  • Non può essere recuperata successivamente, deve essere archiviata in modo sicuro
  • La chiave include un carattere di checksum per la validazione
  • Le eliminazioni sono soft delete (plugin

Request​

Responses​

Chiave API creata con successo

Response Headers