1 – O que é o DEVPORTAL?
Trata-se de um portal de desenvolvimento localizado no endereço https://devportal.dataprev.gov.br no qual há várias informações sobre as APIs, consoles para testes e sdks para download. No portal também é feito o registro de aplicações que consumirão as APIs.
2 – No DEVPORTAL, é possível baixar arquivos para teste?
Sim. Na aba operações da API é possível baixar uma arquivo para testes. Clique no link /swagger.json com o botão direito do mouse e selecione a opção Salvar link como, escolha um diretório no seu computador e nomeie o arquivo, por exemplo, “contrato.js”
3 – Em quais ambientes são hospedadas as API da Dataprev?
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.
4 – Quais são os princípios das API?
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.
5 – Qual é o padrão que as respostas das API se utilizam?
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.
6 – Quais são os HTTP Status Code mais utilizados?
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 |
7 – É possível realizar testes com a API de degustação?
Sim, é possível realizar testes com a API de degustação, utilizando, por exemplo, o aplicativo Postman. Faça o download e a instalação do mesmo para prosseguir.
Uma vez instalado, no momento, é necessário desativar a checagem de SSL para consulta às APIs de degustação. No Postman, entre em Settings (engrenagem no canto superior direito), e em seguida desmarque a opção SSL certificate verification e feche a janela.:
Depois do Postman configurado, é necessário fazer o download do arquivo swagger com os contratos consolidados e da planilha com os dados de referência para testes.
Uma vez que os tenha, importe arquivo json no Postman:
Depois da importação, é necessário obter o token para consulta. Isso é feito via chave e segredo, ambos já configurados no arquivo. Uma vez importada a coleção, clique em Dataprev para abrir as opções de autenticação:
8 – Como faço para subcrever a API contratada?
É necessário acessar o portal de desenvolvimento, cadastrar uma aplicação e realizar a subscrição da API. Estes passos serão detalhados a seguir.
Registre-se no DevPortal
O primeiro passo para realizar o consumo de uma API Dataprev inicia com a solicitação de cadastro feita por meio do gerente de contas. Após a realização do cadastro, o parceiro receberá um e-mail com link para alterar a senha de acesso à área privado do portal de desenvolvimento.
O acesso ao portal é realizado por meio do endereço https://devportal.dataprev.gov.br. Para iniciar, basta acessar a opção Entrar e, na nova tela, informar o CPF, a nova senha e clicar no botão SIGN IN:
Cadastre a Aplicação
Após acessar o portal de desenvolvimento, será necessário cadastrar uma aplicação. Acesse o menu Aplicações, em seguida Adicionar aplicação. Informe o nome da aplicação e acione o botão Adicionar.
Para finalizar o cadastro da aplicação é preciso gerar as chaves que serão utilizadas para obtenção de tokens de acesso. Acesse a aba Chaves de Produção, marque os Grant types Client Credential e Refresh Token, e acione o botão Gerar Chaves.
Realizado o cadastro da aplicação, é necessário realizar a subscrição na API. Para realizar a subscrição, acesse o menu APIs e selecione a API desejada.
Concluído o processo de subscrição de uma API, o passo final é configurar a aplicação cliente com a Consumer Key e Consumer Secret geradas e também com a URI da API subscrita. Concluído estes passos a aplicação estará pronta para consumir uma API Dataprev.
9 – O que são os Grant Types?
São fluxos por meio do qual aplicações podem obter tokens para acesso a APIs, seus recursos e operações. O protocolo OAuth 2.0 oferece vários fluxos.
10 – Como é medido o consumo do Serviço de consulta à API?
Para se chegar ao faturamento mensal, é utilizado o mecanismo de bilhetagem para medição da quantidade consumida da capacidade de uma API. O Bilhetador considera o respectivo plano de inscrição e é capaz de aferir o consumo pelo número total de requisições discriminadas (sucesso e insucesso) e o percentual de consumo frente ao respectivo plano contratado. O cliente receberá na data acordada o RGNS – Relatório de Gerenciamento de Nível de Serviços com todas as informações sobre a prestação de serviço no mês em análise, o que inclui seu consumo aferido por meio da bilhetagem do serviço.
11 – Qual a Disponibilidade do Serviço?
As APIs que atenderão o Sistema Nacional de Informações de Registro Civil estarão disponíveis em regime de operação 24×7, exceto durante janelas de manutenção programadas, conforme calendário anual de manutenções programadas da Dataprev. O índice de disponibilidade do serviço será de 96% (noventa e seis porcento) dentro dos horários previstos no regime de operação. Já o índice de TMRI será aplicado com a tolerância de até 4 (quatro) horas para cada registro de incidente grave de indisponibilidade ocorrido.
12 – O que são APIs ConectaGov?
O ConectaGov consiste na realização de consultas por meio de webservice, oferecidas pela Secretaria Especial de Desburocratização, Gestão e Governo Digital – SGD, nas bases de dados governamentais, via gateway de API, que serão disponibilizadas mediante chamadas pelas aplicações/serviços de Governo.
13 – No Postman é possível fazer consulta em Lote?
Sim, pois o Postman é um programa de consulta a APIs. Mas, no caso das API disponibilizadas pela DATAPREV, não é possível obter esta consulta por meio de uma única operação, pois não possui endpoints para esta finalidade. Entretanto, é possível criar um loop de consulta na ferramenta que possibilite realizar a operação “n” vezes.
14 – Para quem devo encaminhar solicitação de acesso aos Dados do CNIS?
A solicitação deve ser encaminhada à Diretoria de Benefícios do INSS por meio do email:
15 – Como faço para acessar o Portal de Desenvolvimento?
O acesso ao portal é realizado por meio do endereço https://devportal.dataprev.gov.br. Para iniciar basta acessar a opção Entrar(Figura 1), informar o CPF, a nova senha e clicar no botão SIGN IN.
16 – Como faço para cadastrar uma aplicação no DEVPortal?
Acesse o Menu Aplicações, e acione o botão Adicionar Aplicação. Informe o nome da Aplicação e acione o Botão Adicionar.
Para finalizar o cadastro da aplicação é preciso gerar as chaves que serão utilizadas para obtenção de tokens de acesso. Acesse a aba Chaves de Produção marque os Grant type a serem utilizados e acione o botão Gerar Chaves.
17 – Como subscrever a API de Teste?
Realizado o cadastro da aplicação, é necessário realizar a subscrição da API de Degustação. Estas APIs são disponibilizadas para que os desenvolvedores possam testar suas aplicações. APIs de Degustação contemplam as mesmas definições da API, porém utilizam dados fictícios (API Mocking).Para realizar a subscrição, acesse o menu API se selecione a API de Degustação desejada.
Ao acessar a API, no canto superior direito, selecione a aplicação criada, plano de consumo disponível e acione o botão subscrever.
18 – Como realizar um Teste na API?
Concluída a subscrição, é possívelrealizar um teste com a API de Degustação,utilizando,por exemplo,o aplicativo Postman.Inicie realizando o download da definição da API, na aba operações da API, no link /swagger.json, clique com o botão direito do mouse e selecione a opção Salvar link como,escolha um diretório no seu computador e nomeie o arquivo com um nome, por exemplo, “contrato.js”.
Em seguida realize a importação no Postman. Acesse o menu File opção Import.
Clique no botão Upload Files e então selecione o arquivo salvo anteriormente.
Nas opções request parameter generati one response parameter Generation selecione Schema . Acione o botão Importe posteriormente o botão Confirme and Close.
Na aba collections selecione a coleção para configuração de segurança e obtenção do Acess Token. Inicie selecionando OAuth 2.0em Authorization, no campo Type.
Na aba Authorization, em Configure new token, dê um nome para o token no campoToken name. Em Grant Type selecione Client Credentials, em Access Token URL informe a URL https://api.dataprev.gov.br/token. Em Client ID informe o Consumer Key, em Client Secret informe a Consumer Secret, ambos gerados no cadastro de aplicação. Acione o botão Get New Access Token.
Caso a API tenha definido escopos customizados para acesso a recursos e operações, será necessário informar o escopo, em Scope, para geração do token.
Após a obtenção do token aparecerá uma tela confirmando a requisição de um novo token.
Acione o Botão “Use Token”.
Estando configurado o token de acesso, é hora de testar as operações da API. As operações podem ter como entrada um ou mais parâmetros dos tiposcPath ou Query, que devem ser informados na aba Params.
Algumas operações podem receber um objeto jsonde entrada com um conjunto de dados. Este objeto deve ser informado na aba Body.
19 – Como faço para realizar o Teste de Operação da API?
Para realizar o teste da operação da API, é necessário fazer uso do token de acesso configurado nos passos anteriores. Então, no postman, na aba Auth em Type selecione OAuth 2.0 e em Acess Token selecione o token (nome) configurado.
20 – Como subscrevo a API no ambiente de Produção?
Para realizar a subscrição, acesse o menu APIs e selecione a API desejada. Ao acessar a API, no canto superior direito, selecione a aplicação, o plano de consumo disponível e acione o botão subscrever.