Pular para o conteúdo
Endpoints

Autenticação

Gerar o token de acesso

POSThttps://production.bredasapi.com.br/overall/auth/integracao

Sem o botão Testar: esta chamada recebe a chave de integração, que nunca deve ir para o navegador. Faça-a a partir do seu servidor.

Troca a chave de integração por um token, que vai no header Authorization de todas as outras chamadas, sem o prefixo Bearer.

  • O token vale 24 horas e não é renovado: gere outro com a mesma chave.
  • Gerar um token novo não invalida os anteriores.
  • O token guarda as empresas liberadas no momento em que foi gerado.

Chame a partir do seu servidor. A chave é uma senha: nunca a coloque no navegador nem em aplicativo instalado no celular.

  • Sem token: recebe a chave de integração
  • JSON

Requisição

O que o seu sistema envia para a API nesta chamada.

Headers

Informações que vão junto com a chamada, como o token de acesso.

  • Content-Typetextostringobrigatório
    Avisa que o corpo está em JSON.

    Exemplo: application/json

Corpo application/jsonobrigatório

Os dados enviados na chamada, em formato JSON.

  • chavetextostringobrigatório

    Chave de integração, gerada pelo administrador do grupo no sistema (exibida uma única vez)

Respostas

O que a API devolve. O número diz como a chamada terminou: os que começam com 2 deram certo, com 4 indicam um problema no que foi enviado e com 5 um erro do nosso lado.

  • 201CriadoCreated

    Token gerado

    Corpo application/json

    • datagrupo de camposobject

      Token gerado. Atenção: os campos desta resposta são snake_case, diferente do resto da API

      Campos de data
      • access_tokentextostring

        Token a enviar no header Authorization, sem Bearer

      • created_datedata e horastring <date-time>

        Quando o token foi gerado, em UTC

      • expire_datedata e horastring <date-time>

        Quando o token expira, em UTC

      • expires_innúmero inteirointeger <int32>

        Validade em MINUTOS (1440), não em segundos

      • gmt_offsetnúmero inteirointeger <int32>

        Fuso do grupo em horas em relação ao UTC (ex.: -3). Use para converter as datas da API para o horário do grupo

  • 400Dados inválidosBad Request

    Dados inválidos ou regra de negócio não atendida. A mensagem em errors diz o motivo.

    Corpo application/json

    • errorslistaarray[object]pode vir vazio

      Lista de erros, com a mensagem de cada um

      Campos de cada item de errors
      • errorMessagetextostringpode vir vazio

        Mensagem do erro, em português

      • fieldtextostringpode vir vazio

        Campo que causou o erro, quando houver

      • valuetextostringpode vir vazio

        Valor recebido no campo, quando houver

    • sessionGuidtextostringpode vir vazio

      Identificador da requisição. Informe ao suporte quando pedir ajuda

  • 500Erro no servidorInternal Server Error

    Erro inesperado do nosso lado. Tente de novo; se persistir, fale com o suporte.

    Corpo application/json

    • errorslistaarray[object]pode vir vazio

      Lista de erros, com a mensagem de cada um

      Campos de cada item de errors
      • errorMessagetextostringpode vir vazio

        Mensagem do erro, em português

      • fieldtextostringpode vir vazio

        Campo que causou o erro, quando houver

      • valuetextostringpode vir vazio

        Valor recebido no campo, quando houver

    • sessionGuidtextostringpode vir vazio

      Identificador da requisição. Informe ao suporte quando pedir ajuda