Referência API

Autenticação

Para poder executar operações de escrita, é necessário obter uma Chave de API nas definições do seu perfil.

Esta chave deve ser fornecida em cada chamada no cabeçalho HTTP X-API-KEY.

Autorizações

As chamadas à API estão sujeitas às mesmas permissões que a interface web.

Por exemplo, é necessário fazer parte de uma organização para modificar um dos 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, pois os URLs estão disponíveis na resposta nos atributos previous_page e next_page. Estes serão definidos como null se não existir página anterior e/ou seguinte.

Exemplo:

{
  "data": [
    "{...}",
    "{...}"
  ],
  "page": 1,
  "page_size": 20,
  "total": 10,
  "next_page": "https://dados.gov.pt/api/1/endpoint/?page=2",
  "previous_page": null
}