Catalisa.Building Blocks

API do API Keys

14 endpoints em 3 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

15 endpoints

Chaves de API

/api-keys/api/v1/api-keys8
  • POST/api-keys/api/v1/api-keysCria a chave e devolve o valor completo, uma única vezAPI_KEYS_CREATE
  • GET/api-keys/api/v1/api-keysLista as chaves, paginadoAPI_KEYS_READ
  • GET/api-keys/api/v1/api-keys/:keyIdBusca uma chave (sem o segredo)API_KEYS_READ
  • PATCH/api-keys/api/v1/api-keys/:keyIdAtualiza nome, escopos, limites e expiraçãoAPI_KEYS_UPDATE
  • POST/api-keys/api/v1/api-keys/:keyId/rotateGera novo segredo com período de graçaAPI_KEYS_ROTATE
  • POST/api-keys/api/v1/api-keys/:keyId/revokeRevoga a chave imediatamenteAPI_KEYS_DELETE
  • DELETE/api-keys/api/v1/api-keys/:keyIdExclusão lógicaAPI_KEYS_DELETE
  • GET/api-keys/api/v1/api-keys/:keyId/usageEstatísticas de uso por períodoAPI_KEYS_READ_USAGE

Subcontas

/api-keys/api/v1/subaccounts6
  • POST/api-keys/api/v1/subaccountsCria a subconta (name, externalRef?, monthlyQuota?, metadata?); externalRef repetido na organização é 409SUBACCOUNTS_CREATE
  • GET/api-keys/api/v1/subaccountsLista, paginado; filter[status], filter[externalRef] e search (nome ou externalRef)SUBACCOUNTS_READ
  • GET/api-keys/api/v1/subaccounts/:idBusca uma subcontaSUBACCOUNTS_READ
  • PATCH/api-keys/api/v1/subaccounts/:idNome, externalRef, monthlyQuota, metadata, status e suspendedReasonSUBACCOUNTS_UPDATE
  • POST/api-keys/api/v1/subaccounts/:id/api-keysEmite chave da subconta (mesmo corpo da criação de chave)API_KEYS_CREATE
  • GET/api-keys/api/v1/subaccounts/:id/api-keysChaves da subconta, paginadoAPI_KEYS_READ

Saúde

/api-keys/health1
  • GET/api-keys/healthSonda de disponibilidade do serviço