API - Application Programming Interface

---

Retorna uma listagem com todas as entidades. Pode usar filtros de pesquisa passando parâmetros na string de consulta.

URL

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

HEADERS

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição	Exemplo
method	string		Método a invocar. * Caso seja enviado a vazio, este irá se comportar como se tivesse sido colocado a opção: "entitiesList"	entitiesList
id	integer		Identificador específico pelo qual pretende procurar uma determinada entidade.	423451
type	string		Identificador específico pelo qual pretende procurar um tipo de entidade.	socio
fiscal_id	string		Identificador específico pelo qual pretende procurar um número de identificação fiscal.	999999990
email	string		Identificador específico pelo qual pretende procurar um email.	xpto@gmail.com
phone	string		Identificador específico pelo qual pretende procurar um número de telefone.	910383855
active	boolean		Identificador específico pelo qual pretende procurar se uma entidade está activa.	true

Responses

200	SUCCESS Listagem de entidades obtida com sucesso.
401	AUTHENTICATION ERROR Parâmetros de autentificação incorrectos.	(Empty Response)

Example Success Body Response

{
    "entities": [
        {
            "id": "1",
            "numero": "#1",
            "nome": "Carlos Eduardo Matos",
            "tipo": "socio",
            "pais": "Portugal",
            "morada": "Rua de Goda",
            "localidade_morada": "",
            "cpostal": "4590-756",
            "localidade_postal": "",
            "email": "xpto@gmail.com",
            "nif": "123456789",
            "foto": "https://preventech.pt/img/user_default_small.png"
        },
        {
            "id": "423451",
            "numero": "S3",
            "nome": "Telmo Silva Leal",
            "tipo": "socio",
            "pais": "Portugal",
            "morada": "",
            "localidade_morada": "",
            "cpostal": "",
            "localidade_postal": "",
            "email": "xpto123@gmail.com",
            "nif": "",
            "foto": "https://preventech.pt/img/user_default_small.png"
        },
        {
            "id": "1995999",
            "numero": "P63",
            "nome": "João Ferreira Castro",
            "tipo": "particular",
            "pais": "Portugal",
            "morada": "",
            "localidade_morada": "",
            "cpostal": "xpto12345@hotmail.com",
            "localidade_postal": "",
            "email": "",
            "nif": "",
            "foto": "https://preventech.pt/img/user_default_small.png"
        }
    ]
}