Skip to main content

Eliminar a Clave API do Usuario

DELETE 

/company/apikey/:tempCode

Elimina de xeito permanente unha API Key creada polo usuario autenticado, revogando o acceso programático asociado a esa credencial.

Obxectivo

Permitir aos usuarios revogar as súas propias API Keys cando xa non son necesarias ou cando se sospeita que foron comprometidas.

Casos de Uso

  • Revogar o acceso dunha integración descontinuada
  • Eliminar unha clave comprometida ou filtrada accidentalmente
  • Rotar credenciais eliminando a antiga e creando unha nova
  • Limpar claves de proba que xa non se utilizan

Fluxo de operación

flowchart TD
A[Recibir Solicitude DELETE] --> B{Usuario Autenticado?}
B -->|Non| C[401 Unauthorized]
B -->|Si| D{Usuario Existe?}
D -->|Non| E[404 USER_NOT_FOUND]
D -->|Si| F{temp_code Proporcionado?}
F -->|Non| G[400 TEMP_CODE_NOT_PROVIDED]
F -->|Si| H{API Key Existe?}
H -->|Non| I[404 APIKEY_NOT_FOUND]
H -->|Si| J{Key Pertence ao Usuario?}
J -->|Non| K[401 CANT_DELETE]
J -->|Si| L[Soft Delete Key]
L --> M[200 APIKEY_DELETED]

Consideracións importantes

  • Só se poden eliminar claves propias do usuario
  • Usa o temp_code (non a clave real) para identificar a API Key
  • A eliminación é soft delete (mongoose-delete plugin)
  • A clave eliminada non aparecerá en listados futuros
  • Non se pode desfacer a eliminación mediante a API pública

Formato do temp_code

  • String alfanumérico de aproximadamente 25 caracteres
  • Exemplo: 2c3srejxqa176128918935tzv
  • Obtense de GET /company/apikey/ ou ao crear a clave

Notas de Seguridade

  • Verificar que todas as integracións que usan

Request

Responses

Clave API eliminada con éxito

Response Headers