1. Introdução
  • Introdução
    • Comece Aqui
    • Autenticação
    • Recursos
  • API
    • Enterprise
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Profile
    • Company
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Order
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
    • Customer
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Validate phone
      • Blocked (batch)
      • Search individual
      • Search external
      • Track Record
      • Point
    • Withdrawal
      • Rescue
      • Reactivate
      • Show
      • Delete
      • Index
      • Search available
      • Quantity
      • Quantity Company (Monthly)
      • Quantity (Last Days)
    • Activation
      • Create
      • Update
      • Show
      • Delete
    • Promotion
      • Create
      • Update
      • Show
      • Delete
      • Index
    • Submission
      • Index
      • Show
      • Delete
    • Individual
      • Create
      • Index
      • Delete
    • Campaign
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Profile
      • Profile
      • Update profile
      • Update password profile
      • Inactivate
    • User
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Role
      • Create
      • Index
    • Permission
      • Create
      • Index
      • Delete
      • Show
      • Update
    • Status
      • Create
      • Index
      • Update
      • Delete
    • Tag
      • Create
      • Index
      • Update
      • Delete
    • Segment
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Pre Query Builder Segment
    • Product
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
      • Quantity
      • Quantity Sale Product Enterprise
      • Quantity Sale Product Enterprise (Monthly)
    • Webhooks
      • Overview
      • Create
      • Index
      • Delete
    • Billing
      • Quota
      • Index
      • Show
    • User Access Pin
      • Request
      • Revalidate
    • Target
      • Create
      • Delete
    • Redeem
      • Create
      • Index
    • Reward
      • Create
      • Index
      • Update
      • Delete
      • Show
      • Update active
    • Subscription
      • Index
      • Webhook Asaas
    • Payment Profile
      • Index
      • Update
  1. Introdução

Autenticação

Nossas APIs usam uma JWT token para autenticação. O token deve ser incluído no cabeçalho de cada solicitação para verificar a identidade e as permissões do cliente. O token deve ser passada como o valor do cabeçalho Authorization.

Usando o Token API#

Para autenticar uma solicitação de API, inclua seu Beare Token no cabeçalho da solicitação:
Authorization: <Bearer $TOKEN>

Exemplo de uma solicitação de API autenticada.#

Aqui está um exemplo de como fazer uma solicitação GET para a API com a chave da API:

Request.#

GET /api.storycrm.app/v1/customers/{customer_id}
Headers:
  Authorization: Bearer $TOKEN

Response#

{
  [ ... ],
}

Tratamento de erros#

Token API ausente: se o cabeçalho Authorization não estiver incluído, a API retornará um erro indicando que a autenticação é necessária.
Token API inválido: se token fornecido for inválida ou expirada, a API retornará uma mensagem de erro indicando uma falha de autenticação.

Rate Limit#

Por segurança, nossa API suporta somente 50 requisicões por segundo.

Recomendações de segurança#

Mantenha o Token API em segredo: trate seu Token API como uma senha. Não a compartilhe nem o exponha em código do lado do cliente.
Regenere a chave se estiver comprometida: se você suspeitar que seu Token API foi comprometido, solicite um novo imediatamente e atualize seus aplicativos.
Modificado em 2025-10-22 03:11:31
Página anterior
Comece Aqui
Próxima página
Recursos
Built with