Com a conclusão do desenvolvimento e o início da promoção da aplicação para o ambiente de produção, é necessário realizar a subscrição da API contratada. Para realizar a subscrição é 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 Apliaçã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.
Atenção: As chaves da aplicação (Consumer key e Consumer Secret) utilizadas para realizar a subscrição da API devem ser protegidas de acesso não autorizado.
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. A figura abaixo apresenta o grant type Client Credential, recomendado para uso na comunicação entre aplicações:
Subscrevendo à API
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.
Ao acessar a API, no canto superior direito, selecione a aplicação criada, plano de consumo disponível e acione o botão Subscrever.
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.