Documentação da API
Esta página descreve o comportamento da API do dados.gov.
Autenticação
Para que seja possível executar as operações de escrita, precisa primeiro de se autenticar/registar e obter uma chave de API nas configurações do seu perfil.
Esta chave deve ser fornecida em cada chamada à API no cabeçalho HTTP X-API-KEY
.
Autorizações
As chamadas à API estão sujeitas às mesmas permissões que a interface web (frontend).
Por exemplo, é necessário pertencer a uma organização para modificar os seus conjuntos de dados.
Paginação
Alguns métodos são paginados e seguem sempre o mesmo padrão. A lista de objetos é encapsulada num objeto Page.
Não é necessário calcular as páginas anterior e seguinte porque as URLs estão disponíveis na resposta sob os atributos previous_page e next_page. Estes serão definidos como null se não existir nenhuma página anterior ou seguinte.
Exemplo:
{
"data": [{...}, {...}],
"page": 1,
"page_size": 20,
"total": 368,
"next_page": "https://dados.gov.pt/api/endpoint/?page=2",
"previous_page": null
}