API - Application Programming Interface

Autenticação

Para autenticar um utilizador é necessário uma chave de API e um Token. Todos os endpoints da API estão disponíveis via HTTPS. O Acesso HTTP é negado. Cada chave de API autentica um utilizador dentro de uma conta e é composta por caracteres gerados aleatóriamente.

Essa chave deve ser passada no header do pedido. Embora toda a comunicação esteja encriptada, aconselhamos a manter este token o mais seguro possível para evitar que terceiros tentem aceder aos dados.

Outro parâmetro a constar no header dos pedidos é o Token que será utilizado em todas as comunicações. Este Token é válido durante 7 dias pelo que deverá ser renovado.

Exemplo cabeçalho:


                            Accept: application/json
                            apikey: API_KEY
                            X-AccessKey: ACCESS_KEY

Criação do Token:

URL

https://api.gescorp.pt/api/v1/authentication

HEADERS

Accept: application/json
                            apikey: API_KEY

Responses


200	SUCCESS X-AccessKey gerada/obtida com sucesso.	X-AccessKey Get
401	AUTHENTICATION ERROR Parâmetros incorrectos.	(Empty Response)

Example Success Body Response

{
    "authentication": {
        "access_key": "xxxxxxxxxxxxxxxx",
        "expiration_date": "1970-08-17 00:00:00"
    }
}