DaaS

Bem-vindo à documentação das APIs disponibilizadas pela Dataprev.

Em nossa documentação, você irá encontrar as informações necessárias para integrar suas aplicações às APIs da Dataprev.

Padrões

Seguimos padrões e boas práticas de mercado para o desenvolvimento de nossas APIs. Abaixo, estão alguns dos padrões de APIs na Dataprev.

Ambientes

As APIs da Dataprev possuem um ambiente único para consumo de degustação, disponível abertamente para o público, e de produção para consumo para seus clientes.

O ambiente de degustação funciona como ambiente de teste e desenvolvimento, com a utilização de dados fictícios, também chamado de dados mockados, a fim de permitir que o desenvolvedor tenha o primeiro contato e entenda o funcionamento da API. Desta forma, os dados de retorno são utilizados para testes unitários e de integração.

No menu à esquerda, você poderá acessar nosso ambiente de degustação e realizar testes de forma simplificada e rápida.

Princípio das APIS

Nossas APIs seguem os seguintes princípios:

Restful

Nossas APIs estão aderentes aos conceitos de Restful sempre que possível.

Agnósticas

Nossas APIs são agnósticas à implementação, podendo ser implementada em diversas linguagens de programação.

Segurança

Nossas APIs são desenvolvidas observando todos os critérios de segurança esperados para as transações para clientes de governo e cidadão.

Padrões HTTP Status Code

Em nossas APIS, as respostas seguem o padrão de HTTP Status code [RFC 7231]:

200-299 – A requisição foi recebida e executada com sucesso.

400-499 – A requisição contém um erro de sintaxe ou formatação e não pode ser realizada.

500-599 – O servidor possui um erro e não pode executar uma requisição aparentemente válida.

Nossos HTTP Status Code mais utilizados são:

200	Ok
201	Created
400	Bad Request
403	Forbidden
404	Not Found
405	Method Not Allowed
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Acordo de Nível de Serviço (ANS/SLA)

Nosso ambiente de degustação é estável e possui tempo de resposta similar as operações em ambiente de produção, no entanto, como se trata de uma estrutura para testes, não é adequada para testes de carga.

Ajuda

Acompanhe a seção de Erros Frequentes e Dúvidas Gerais. Nessas seções você poderá encontrar diversas explicações relacionadas ao negócio e ao consumo da API.