Visão Geral

A API permite chamar métodos pelo protocolo HTTP e envia a respostas no estilo REST JSON.

Autenticação

Para autenticação é necessário enviar a chave da API no Header X-API-Key de cada pedido. A chave da API pode ser obtida na sua conta depois de se registar.

A autenticação é necessária em todos os pedidos.

Encoding

Use a codificação UTF-8 em todos os pedidos à API.

Versão

1.0.0 (Draft)
Data criação: 2025/03/15
Última atualização: 2025/03/15
Root URL: https://geopt.pt/

Testar

A melhor maneira de testar o serviço é criar uma conta.
Após criar uma conta terá uma chave da API válida durante 15 dias.

Criar conta

Códigos de Resposta

Os códigos de resposta são baseados no formato HTTP.

Code           Message
200            OK
201            Created
400            Bad Request
401            Unauthorized
403            Forbidden
404            Not Found
405            Method Not Allowed
500            Internal Server Error
501            Not Implemented

Endpoints

Obter as moradas referentes ao código postal enviado.

Pedido

POSTEndpoint: /api/v1/search
Host: https://geopt.pt

Payload

JSON{
	"pc4": "2530",
	"pc3": "073"
}

Resposta

JSON{
    "code": 200,
    "status": "OK",
    "message": "Data retrieved successfully",
    "data": {
        "pc": "2530-073",
        "locality": "Lourinhã",
        "city": "Lisboa",
        "district": "Lisboa",
        "extra": "Lourinhã, Lisboa",
        "addresses": [
            {
                "street": "Beco da Palmeira",
                "gps": "39.202397,-9.329441"
            },
            {
                "street": "Largo do Silva",
                "gps": "39.245698,-9.315684"
            },
            {
                "street": "Rua do Lenteiro",
                "gps": "39.218768,-9.293706"
            },
            {
                "street": "Travessa das Marias",
                "gps": "39.219983,-9.293801"
            },
            {
                "street": "Rua dos Cesteiros",
                "gps": "39.219303,-9.293796"
            },
            {
                "street": "Travessa do Rato",
                "gps": "39.220418,-9.293959"
            },
            {
                "street": "Rua 1º de Maio",
                "gps": "39.334715,-9.265771"
            },
            {
                "street": "Rua 3 de Janeiro",
                "gps": "39.256999,-9.287579"
            },
            {
                "street": "Rua da Indústria",
                "gps": "39.200084,-9.307083"
            },
            {
                "street": "Avenida 24 de Junho",
                "gps": "39.222311,-9.313901"
            },
            {
                "street": "Rua do Comércio",
                "gps": "39.287249,-9.214580"
            },
            {
                "street": "Rua Nova",
                "gps": "39.259119,-9.320856"
            },
            {
                "street": "Rua do Rosmaninho",
                "gps": "39.202397,-9.329441"
            },
            {
                "street": "Rua das Papoilas",
                "gps": "39.219153,-9.293850"
            },
            {
                "street": "Rua da Encosta",
                "gps": "39.280697,-9.222212"
            }
        ]
    }
}

Changelog

2025/03/15

  • Lançamento