ZypfyDocs Acessar painel
Autenticação

Autenticar e obter token Bearer

POSThttps://api.zypfy.com/api/auth/login

Autentica o merchant com client_id + client_secret e devolve um JWT válido por 1 hora. Use o token em todas as chamadas subsequentes no header Authorization: Bearer SEU_TOKEN.

Rate limit

100 tentativas de login por IP a cada 15 minutos. Logins bem-sucedidos não contam para o limite — apenas as falhas (senha / credencial inválida). Se exceder, você recebe HTTP 429 com a mensagem Too many login attempts. Try again in 15 minutes. e precisa esperar a janela reabrir — não existe workaround, nem em produção. Na prática, quem cacheia o token (abaixo) nunca chega perto desse limite.

Cache do token (obrigatório)

Reutilize o mesmo token por até ~55 minutos. Só peça um novo em duas situações:

Se múltiplos processos do seu backend saem do mesmo IP e cada um tenta fazer login independentemente, o rate limit vai bloquear todos. Use um cache compartilhado (Redis, memcached, tabela no banco) para uma cópia única do token entre os workers.

Corpo da requisição

Respostas

200Autenticação bem-sucedida. JWT retornado em token.
  • messagestring
    exemplo: Authentication successful.
  • tokenstring

    JWT válido por 1 hora (3600s).

    exemplo: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  • userobject
    campos de user
    • idinteger
      exemplo: 42
    • namestring
      exemplo: Minha Loja
    • emailstring (email)
    • verification_docsinteger

      1 se o KYC está aprovado, 0 caso contrário.

      valores: 0 1
      exemplo: 1
400Campos obrigatórios ausentes ou malformados.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.

401Credenciais inválidas.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.

403Conta banida ou credenciais não configuradas para este usuário.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.

429Rate limit excedido (100 / 15 min por IP; logins bem-sucedidos não contam).
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.