Skip to main content

Crear Nova Chave API

POST 
/company/apikey/

Crea unha nova API Key para o usuario autenticado asociada á súa compañía, permitindo autenticación programática para integracións externas e automatizacións.

Obxectivo​

Xerar credenciais seguras de tipo API Key que permitan acceso programático aos recursos da compañía segundo o tipo de permisos especificado.

Casos de Uso​

  • Integración con sistemas externos de xestión de transporte
  • Automatización da creación de poxas mediante scripts
  • Xeración automática de facturas desde plataformas de terceiros
  • Desenvolvemento de aplicacións personalizadas que consomen a API de CargoOffer

Límites​

  • Máximo 4 API Keys por compañía
  • Se se alcanza o límite, retornarase erro 403 con código MAX_APIKEYS
  • Cada key é única e irrecuperable unha vez creada

Fluxo de operación​

flowchart TD
  A[Recibir Solicitude] --> B{Usuario Autenticado?}
  B -->|Non| C[401 Unauthorized]
  B -->|Si| D{Usuario Existe?}
  D -->|Non| E[404 USER_NOT_FOUND]
  D -->|Si| F{Compañía Existe?}
  F -->|Non| G[404 COMPANY_NOT_FOUND]
  F -->|Si| H{API Keys < 4?}
  H -->|Non| I[403 MAX_APIKEYS]
  H -->|Si| J{Tipo Válido?}
  J -->|Non| K[400 Validación Mongoose]
  J -->|Si| L[Xerar Key 40 chars]
  L --> M[Xerar temp_code]
  M --> N[Gardar en DB]
  N --> O[201 Created + Key Completa]

Consideracións importantes​

  • A API Key só se mostra completa no momento da creación
  • Non se pode recuperar posteriormente, debe almacenarse de forma segura
  • A chave inclúe un carácter de checksum para validación
  • As eliminacións son soft delete (mongoose-delete plugin)

Notas de Seguridade​

  • Almacenar a API Key

Request​

Responses​

Clave da API creada con éxito

Response Headers