Pular para o conteúdo principal

Create New API Key

POST 
/company/apikey/

Cria uma nova API Key para o usuário autenticado associada à sua empresa, permitindo autenticação programática para integrações externas e automações.

Objetivo​

Gerar credenciais seguras do tipo API Key que permitam acesso programático aos recursos da empresa de acordo com o tipo de permissão especificado.

Casos de Uso​

  • Integração com sistemas externos de gestão de transporte
  • Automação da criação de leilões por meio de scripts
  • Geração automática de faturas a partir de plataformas de terceiros
  • Desenvolvimento de aplicativos personalizados que consomem a API do CargoOffer

Limites​

  • Máximo de 4 API Keys por empresa
  • Se o limite for atingido, será retornado erro 403 com código MAX_APIKEYS
  • Cada chave é única e irrecuperável uma vez criada

Fluxo de operação​

flowchart TD
  A[Receber Solicitação] --> B{Usuário Autenticado?}
  B -->|Não| C[401 Não Autorizado]
  B -->|Sim| D{Usuário Existe?}
  D -->|Não| E[404 USUÁRIO_NÃO_ENCONTRADO]
  D -->|Sim| F{Empresa Existe?}
  F -->|Não| G[404 EMPRESA_NÃO_ENCONTRADA]
  F -->|Sim| H{API Keys < 4?}
  H -->|Não| I[403 MAX_APIKEYS]
  H -->|Sim| J{Tipo Válido?}
  J -->|Não| K[400 Validação Mongoose]
  J -->|Sim| L[Gerar Key 40 chars]
  L --> M[Gerar temp_code]
  M --> N[Salvar no BD]
  N --> O[201 Criado + Key Completa]

Considerações importantes​

  • A API Key só é exibida por completo no momento da criação
  • Não pode ser recuperada posteriormente, deve ser armazenada de forma segura
  • A chave inclui um caractere de checksum para validação
  • As exclusões são soft delete (plugin mongoose-delete

Request​

Responses​

Chave da API criada com sucesso

Response Headers