Pular para o conteúdo
DocumentaçãoVisão geral

Documentação da API e do MCP

Tudo o que você precisa para integrar a base de empresas ao seu sistema pela API ou ao seu assistente de IA pelo MCP.

Atualizado em · API v1

Duas formas de integrar

API por token

Para o seu sistema, CRM ou planilha automatizada.

  • Token da API no cabeçalho de cada chamada.
  • Ficha de um CNPJ, contagem de empresas, ranking de um recorte e contagem de obras.
  • Cada requisição admitida conta 1 chamada da cota do mês.

Fazer a primeira chamada

MCP para assistentes de IA

Para pedir em português ao Claude, ao ChatGPT ou ao Cursor.

  • Login com a sua conta, sem token.
  • Buscar empresas, consultar um CNPJ e trabalhar no CRM da conta.
  • 24 ferramentas, que o assistente escolhe conforme o pedido.

Conectar o MCP

URL base

Todas as operações da API ficam sob este endereço, só na versão v1:

URL base
https://app.oportunidados.com.br/api/v1

Por onde começar

  1. Início rápido: crie o token e consulte um CNPJ em poucos minutos.
  2. Autenticação: o token da API, as validades e o login do MCP.
  3. Endpoints do token: as quatro operações, com parâmetros e exemplos.
  4. MCP: permissões, ferramentas e como conectar cada assistente.
  5. Campos da ficha: o que vem em cada seção do JSON.
  6. Cota e limites: chamadas por mês e por minuto de cada plano.
  7. Erros e retentativas: cada código, o corpo da resposta e quando repetir.
  8. Changelog: o que mudou na API, no MCP e nesta documentação.

Referência interativa (Swagger)

Em app.oportunidados.com.br/api-docs você vê os endpoints, os parâmetros e os exemplos de resposta, testa chamadas no navegador com o seu token e baixa a especificação em YAML para gerar clientes.

Cada chamada de teste com o seu token é uma chamada de verdade e usa 1 da cota do mês.

Fazer isso nos primeiros 8 dias encerra a garantia da primeira assinatura. Ver regra

Reportar um problema

Fale com o suporte pelos canais de atendimento e leve:

  1. O que aconteceu, o que você esperava e se acontece sempre ou de vez em quando.
  2. A chamada: endereço, método e o CNPJ consultado, se for o caso.
  3. A resposta: código HTTP e o corpo do erro, com a mensagem exata.
  4. Quando: data, hora e fuso.
  5. Como repetir: o cURL ou um exemplo mínimo de código.

Nunca envie o token. Se precisar mandar logs, apague o token antes.

Segurança

  • Guarde o token em variável de ambiente ou num cofre de segredos, nunca em código público.
  • Se o token vazou, desative-o em Tokens da API e crie outro.
  • Para assunto de segurança, escreva só por e-mail, para suporte@oportunidados.com.br.

Campos novos na resposta

A resposta pode ganhar campos. Faça a sua integração ignorar os campos que ela não conhece e não depender da ordem das chaves. O que muda fica registrado no changelog.

Perguntas frequentes

Tem ambiente de teste?

Não há ambiente gratuito. A API exige assinatura ativa, e um token criado para desenvolvimento usa a mesma cota do plano.

A API devolve uma lista de empresas por filtro?

Pelo token, não. A API consulta a ficha de um CNPJ e conta empresas e obras de um recorte. A busca que devolve a lista de empresas é feita pelo MCP, com o login da conta.

Referência interativa: Swagger do app, com todos os parâmetros e exemplos de resposta.