Introdução

A PTAPI disponibiliza APIs REST para integrar dados portugueses de forma simples. Atualmente, o serviço disponível é a API de Códigos Postais v2.

Base URL

https://api.ptapi.net

Autenticação

A API v2 utiliza um AppID incluído no caminho do pedido. O AppID identifica o acesso atribuído ao utilizador.

GET /ptcp/v2/{AppID}/{CodigoPostal}

A futura área pessoal em my.ptapi.net será o local central para consultar as chaves/identificadores disponíveis e o respetivo consumo.

Formato de resposta

As respostas da API de Códigos Postais v2 são devolvidas em JSON. Como um código postal pode estar associado a mais do que uma morada, a resposta é um array de objetos.

Códigos HTTP

Os códigos abaixo devem ser considerados a convenção documental do PTAPI. Valide o comportamento exato do backend antes da publicação definitiva.