Aller au contenu principal

Create New API Key

POST 
/company/apikey/

Créez une nouvelle clé API pour l'utilisateur authentifié, associée à son entreprise, permettant une authentification programmatique pour les intégrations externes et les automatisations.

Objectif​

Générer des identifiants sécurisés de type clé API permettant un accès programmatique aux ressources de l'entreprise selon le type d'autorisations spécifié.

Cas d'utilisation​

  • Intégration avec des systèmes externes de gestion de transport
  • Automatisation de la création d'enchères via des scripts
  • Génération automatique de factures depuis des plateformes tierces
  • Développement d'applications personnalisées consommant l'API de CargoOffer

Limites​

  • Maximum 4 clés API par entreprise
  • Si la limite est atteinte, une erreur 403 avec le code MAX_APIKEYS sera retournée
  • Chaque clé est unique et irrécupérable une fois créée

Flux d'opération​

flowchart TD
  A[Reception Requête] --> B{Utilisateur Authentifié?}
  B -->|Non| C[401 Non Autorisé]
  B -->|Oui| D{Utilisateur Existe?}
  D -->|Non| E[404 UTILISATEUR_NON_TROUVÉ]
  D -->|Oui| F{Entreprise Existe?}
  F -->|Non| G[404 ENTREPRISE_NON_TROUVÉE]
  F -->|Oui| H{Clés API < 4?}
  H -->|Non| I[403 MAX_APIKEYS]
  H -->|Oui| J{Type Valide?}
  J -->|Non| K[400 Validation Mongoose]
  J -->|Oui| L[Générer Clé 40 caractères]
  L --> M[Générer temp_code]
  M --> N[Sauvegarder en Base de Données]
  N --> O[201 Créé + Clé Complète]

Considérations importantes​

  • La clé API n'est affichée en entier qu'au moment de sa création
  • Elle ne peut pas être récupérée ultérieurement, elle doit être stockée de

Request​

Responses​

Clé API créée avec succès

Response Headers