Pular para o conteúdo
Endpoints

Empresa

Listar as empresas liberadas

GEThttps://production.bredasapi.com.br/api/v1/empresa

Chamada real em produção. Na primeira vez, o teste pede o seu token de acesso.

Empresas do grupo que a integração pode acessar. O idEmpresa de cada uma é usado nos outros recursos e chega no aviso do webhook.

  • Se o administrador escolheu empresas ao criar a integração, só elas aparecem.
  • Se não escolheu nenhuma, aparecem todas as empresas do grupo com contrato ativo.
  • Em qualquer caso, a empresa precisa ter a API de Integração no contrato.

O token guarda as empresas liberadas no momento em que foi gerado: mudanças na integração só aparecem em tokens gerados depois.

  • Token no header Authorization
  • Limite do grupo: 100 requisições, repõe 5 a cada 3 s
  • 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.

  • Authorizationtextostringobrigatório
    Token de acesso gerado em POST /auth/integracao, enviado sem o prefixo Bearer. Vale 24 horas.

    Exemplo: 3f9a1c0e…bredas…c6d7e8f9

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.

  • 200Deu certoOK

    Empresas liberadas

    Corpo application/json

    • datalistaarray[object]pode vir vazio

      Empresas liberadas para a integração

      Campos de cada item de data
      • idEmpresanúmero inteirointeger <int64>

        Id da empresa, usado nos outros recursos

        Exemplo: 989

      • cpfCnpjtextostringpode vir vazio

        CPF ou CNPJ da empresa, só números

        Exemplo: 11222333000181

      • nomeRazaoSocialtextostringpode vir vazio

        Nome ou razão social

      • nomeFantasiatextostringpode vir vazio

        Nome fantasia

  • 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

  • 401Não autorizadoUnauthorized

    Token ausente, inválido, expirado ou enviado com o prefixo Bearer.

    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

  • 429Muitas chamadasToo Many Requests

    Limite de requisições do grupo atingido (até 100 de uma vez; repõe 5 a cada 3 segundos, cerca de 100 por minuto). Espere os segundos do header Retry-After; a mensagem também diz quanto esperar.

    Headers da resposta

    • Retry-Afterinteger

      Segundos a esperar antes de tentar de novo

    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