Documentação
Documentação Técnica
O serviço WSDenatran está disponível através de HTTP REST oferecendo operações que permitem as aplicações realizarem buscas na base do Senatran.
Para utilizar e testar o serviço é necessário o cadastro do certificado habilitado e configurado pelo Serpro, de acordo com o Termo de Autorização emitido pelo Senatran em favor da empresa.
Especificação Técnica
Para acessar as páginas contendo as especificações técnicas, é necessário um certificado digital válido.
Os endereços de endpoints com a relação das consultas os parâmetros de entrada e saída das consultas estão detalhados nos endereços abaixo:
As consultas possuem 3 versões: v1, v2 e v3, sendo a v3 que possui a tecnologia mais otimizada. Sempre indicamos a utilização da consulta mais otimizada ao cliente:
- https://hom.wsdenatran.estaleiro.serpro.gov.br/v1/api-doc
- https://hom.wsdenatran.estaleiro.serpro.gov.br/v2/api-doc
- https://hom.wsdenatran.estaleiro.serpro.gov.br/v3/api-doc
Ao final de cada página acima, em "Models", você encontra o detalhamento dos atributos e seu modelo de atributo, seu tipo do atributo e sua descrição.
Códigos de Retorno das Consultas
| Código de retorno | Resumido | Explicação |
|---|---|---|
| 200 | OK | Tudo funcionou como esperado. |
| 400 | Requisição inválida | A requisição não foi aceita. Geralmente por falta de um parâmetro requerido. |
| 401 | Não autorizado | Problemas durante a autenticação do Certificado ou do CPF do usuário. |
| 402 | Requisição falhou | Os parâmetros foram validados, mas houve algum erro de negócio. |
| 404 | Não encontrado | O recurso solicitado não existe. |
| 500 | Erro no servidor | Ocorreu algum erro interno. |
Tipos de Campos Retornados
| Tipos de campos | Valor de retorno |
|---|---|
| campo de código | número do código ou zerado, se não existir |
| campo de descrição | descrição do código retornado ou INDISPONÍVEL, se não existir |
| campo boleano | false (indicador negativo) ou true (indicador positivo) |
| campo de data | data no formato aaaa-mm-dd, retornada apenas se existir |
| campo de texto | texto ou vazio, se não existir |
| campo numérico | número |
Exemplo de Implementação
No link abaixo vc acessa um exemplo de codificação, inclusive códigos prontos para download: https://hom.wsdenatran.estaleiro.serpro.gov.br/v1/api-example/
Criada: 26 de fevereiro de 2024