Ministério da Saúde
MINISTÉRIO DA SAÚDE
Manual da API da Campanha Nacional de
Vacinação da Covid-19
Manual de API de Vacinação 1
Ministério da Saúde
Sumário
1. Introdução ........................................................................................................ 3
2. Utilização da API ............................................................................................... 3
2.1. URL para consumo da API .....................................................................................3
3. Configurando para Consumir Informações da API .............................................. 4
Manual da API de Vacinação 2
Ministério da Saúde
1. Introdução
O objetivo deste manual é facilitar o consumo dos dados da API da Campanha
Nacional de Vacinação contra a Covid-19 disponível no endereço
https://opendatasus.saude.gov.br/dataset/covid-19-vacinacao.
2. Utilização da API
API é um conjunto de rotinas e padrões de programação para acesso a um
aplicativo de software ou plataforma baseado na Web. A sigla API refere-se ao
termo em inglês "Application Programming Interface" que significa em tradução
para o português "Interface de Programação de Aplicativos".
Através das APIs, os aplicativos podem se comunicar uns com os outros sem
conhecimento ou intervenção dos usuários. Elas funcionam através da
comunicação de diversos códigos, definindo comportamentos específicos de
determinado objeto em uma interface.
2.1. URL para consumo da API
Para consumir os dados disponibilizados pela API, utilizaremos a seguinte URL:
• https://imunizacao-es.saude.gov.br/_search
Com a seguinte credencial de acesso:
Usuário: imunizacao_public
Senha: qlto5t&7r_@+#Tlstigi
2.2. Nomenclatura dos campos de Notificações
A URL retorna os campos listados abaixo no formato .JSON, visando a facilidade
de acesso ao dado por diversas ferramentas e linguagens.
Por se tratar de uma dado semiestruturado deve-se ressaltar que nem todo
registro possui todos as chaves.
Manual de API de Vacinação 3
Ministério da Saúde
3. Configurando para Consumir Informações da API
Utilizaremos o aplicativo Postman (https://www.postman.com/) para exemplificar os procedimentos a serem executados para retornar os
dados.
No Postman, execute os seguintes procedimentos:
Figura 1 – Tela inicial do Postman
Selecionando a aba de Authorization selecione a opção “Basic Auth” conforme a figura 2.
Manual API Vacinação 4
Ministério da Saúde
Figura 2 – Escolhendo o tipo de autenticação
Tal ação exibirá os campos de usuário e senha para autenticação. Preencha os campos com o usuário e senha fornecidos no item 2.1 desse
manual. Aproveite também para preencher a URL com o endereço que também está no item 2.1. O resultado está evidenciado na figura 3.
Manual API Vacinação 5
Ministério da Saúde
Figura 3 – Preenchendo a autenticação e a o endereço da API
Manual API Vacinação 6
Ministério da Saúde
Nessa etapa, ao clicar no botão “Send” a API já é capaz de retornar uma resposta, com 10 registros, como mostra a figura 4.
Manual API Vacinação 7
Ministério da Saúde
Figura 4 – Resposta da requisição
Para consultar mais registros, você deve:
1. Alterar o método da requisição de GET para POST,
2. Alterar para a aba Body e marcar a opção raw,
3. Alterar o tipo de envio de Text para JSON
4. escrever o trecho de código a seguir
na caixa de texto da página:
{
"size": 10000
}
Figura 5 – Passando parâmetros para a consulta
Manual API Vacinação 8
Ministério da Saúde
Caso o número de registros seja maior que 10000, retorne à Figura 5 e adicione o seguinte parâmetro ao final do endereço da API
“?scroll=1m” . O resultado da URL será:
https://imunizacao-es.saude.gov.br/_search?scroll=1m
Manual API Vacinação 9
Ministério da Saúde
Essa requisição devolverá o mesmo JSON da figura 4 só que com uma nova chave "_scroll_id" como a imagem 6 evidencia:
Figura 6 – Resposta da requisição search?scroll=1m
Manual API Vacinação 10
Ministério da Saúde
Com esse Id será possível pedir os dados da segunda “página” em diante. É importante chamar atenção de que essa requisição já traz
o primeiro conjunto de elementos. Note que na linha 17 está o elemento hits que é vetor com os registros. Contudo, para as demais
páginas, uma leve mudança no endereço e no corpo da requisição devem ser feitas. Recomenda-se a criação de uma nova aba no
Postman:
URL: https://imunizacao-es.saude.gov.br/_search/scroll
Corpo: {
"scroll_id": "INSERIR O SCROLL ID DA REQUISIÇÃO ANTERIOR",
"scroll": "1m"
}
Figura 7 – Exemplo da requisição para consultar da segunda página em diante
Manual API Vacinação 11
Ministério da Saúde
É importante ressaltar que o scroll_id é um valor temporário, por isso recomenda-se sempre copiar o valor da última resposta.
Feito isso, o passo final é repetir a requisição até que o elemento hits venha vazio, conforme a figura 8:
Manual API Vacinação 12
Ministério da Saúde
Figura 8 – Retorno após consumo de todos os dados da API
Manual API Vacinação 13
