Documentação completa com exemplos em 5 linguagens. Swagger para testar no navegador. SLA de disponibilidade 24/7. Suporte técnico especializado.
Documentação da API
A Oportunidados oferece documentação completa e atualizada especificamente para a API de CNPJ.
Documentação completa para assinantes: Acesse a documentação oficial da API com exemplos de código, guias de início rápido e referências completas em app.oportunidados.com.br/help/api. Esta documentação inclui:
- Guia de início rápido passo a passo
- Exemplos de código em múltiplas linguagens (Python, JavaScript, Ruby, PHP, cURL)
- Explicação detalhada de autenticação
- Estrutura completa das respostas
- Tratamento de erros e códigos de status
- Boas práticas de segurança e performance
- Informações sobre limites de uso por plano
Documentação Interativa OpenAPI/Swagger: Para testar requisições diretamente e explorar os endpoints de forma interativa, acesse a documentação Swagger disponível no programa. Esta documentação permite:
- Visualizar todos os endpoints disponíveis da API
- Ver exemplos de requisições e respostas em tempo real
- Testar requisições diretamente no navegador usando seus tokens
- Explorar a estrutura de dados de forma visual
- Baixar especificações em formato JSON/YAML para gerar clientes automaticamente
- Entender parâmetros obrigatórios e opcionais
Reportando Bugs da API
Se você identificar um bug ou comportamento inesperado na API, reporte incluindo:
- Descrição clara do problema: o que aconteceu vs. o que era esperado, quando o problema começou (data/hora) e frequência (sempre, intermitente, uma vez)
- Dados técnicos da requisição: endpoint completo utilizado, método HTTP, CNPJ consultado (se aplicável). Importante: NÃO inclua seu token de autenticação
- Resposta recebida: código de status HTTP, corpo completo da resposta de erro (JSON), headers HTTP relevantes e mensagem de erro exata
- Ambiente técnico: linguagem de programação e versão, biblioteca HTTP utilizada, sistema operacional e horário exato da ocorrência (incluindo timezone)
- Como reproduzir: passos detalhados para reproduzir o problema, exemplo de código mínimo que demonstra o erro e, se possível, exemplo usando cURL
Solicitando Novos Recursos para a API
Sugestões de melhorias na API são bem-vindas! Ao sugerir um novo recurso, inclua:
- Descrição do recurso: qual funcionalidade você gostaria de ver e como você imagina que funcionaria
- Justificativa do caso de uso: por que este recurso seria útil, que problema ele resolveria e como você o utilizaria na prática
- Exemplos: como seria a requisição idealizada, a resposta esperada e quais parâmetros seriam necessários
- Alternativas: como você resolve isso atualmente e as limitações da solução atual
Importante: Todas as sugestões são seriamente consideradas pela equipe técnica, mas não geram obrigação de implementação por parte da Oportunidados, conforme estabelecido nos Termos de Uso.
Políticas de SLA da API
Disponibilidade: 24 horas por dia, 7 dias por semana, exceto durante manutenções programadas (notificadas com antecedência via email) e em casos de força maior.
Tempo de Resposta do Suporte:
- Email: primeira resposta em até 2h, se recebido dentro do horário comercial
- Chat: resposta em tempo real durante horário comercial
- WhatsApp: resposta prioritária para questões urgentes
Manutenções da API: comunicadas com antecedência mínima de 24 horas via email, programadas preferencialmente em finais de semana ou horários não comerciais, com comunicação de conclusão após retorno.
Performance da API: tempo de resposta médio inferior a 2 segundos para consultas normais; timeout padrão recomendado de 30 segundos.
Segurança e Confidencialidade
Ao entrar em contato com o suporte sobre questões da API:
- NUNCA compartilhe seu token digest completo em emails, chats ou mensagens
- Se necessário compartilhar logs, remova ou oculte o token antes de enviar
- Para questões sensíveis de segurança, use apenas email — consulte os canais de suporte disponíveis ([email protected])
- Se suspeitar que seu token foi comprometido, desative-o imediatamente e crie um novo
- Reporte vulnerabilidades de segurança diretamente para a equipe técnica
Atualizações e Mudanças na API
Mudanças compatíveis (não quebram integrações existentes): adição de novos endpoints, novos campos opcionais nas respostas, melhorias de performance e correção de bugs.
Mudanças incompatíveis (podem afetar integrações existentes): remoção ou alteração de endpoints, mudanças em campos obrigatórios, alterações em formatos de resposta e mudanças em códigos de erro.
Para mudanças incompatíveis, a Oportunidados garante notificação prévia de no mínimo 30 dias via email, período de transição sempre que possível, documentação atualizada com guias de migração e suporte técnico para auxiliar na adaptação.
Recursos Adicionais
- Especificação OpenAPI: baixe a especificação completa em formato JSON/YAML para gerar clientes automaticamente em diversas linguagens — disponível na documentação interativa Swagger
- Exemplos de Código: disponíveis na documentação oficial em Python, JavaScript, Ruby, PHP e cURL — código pronto para copiar e adaptar, incluindo tratamento de erros e boas práticas
- Monitoramento de Status: acompanhe o uso da sua API na página de tokens — visualize requisições realizadas vs. limite do plano, rate limit e cota mensal restante
