APIv2 PREVENTECH

Preventech REST API v2 em JSON

Este documento tem como objectivo detalhar e especificar o funcionamento do módulo de interfaces (INT) no contexto do sistema de Gestão de Corporações.

GET Authentication

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.

É possível realizar até 100 pedidos por minuto para cada conta. Se este limite for excedido, receberá uma resposta de 429 Too Many Requests.

Recomendamos o tratamento deste tipo de erros de forma a controlar os pedidos seguintes.

https://api.preventech.pt/api/v2/authentication

Autenticação

Este endpoint é utilizado para autenticar o utilizador na API v2 da Preventech. Ao realizar um pedido GET para este endpoint com uma chave de API válida, o sistema valida as credenciais e devolve um token de acesso (Bearer Token) que deverá ser utilizado nos pedidos subsequentes à API.

Headers Obrigatórios

Header Valor Descrição
Accept application/json Indica que a resposta deve ser devolvida no formato JSON.
apikey Chave de API fornecida pela Preventech para identificar e autenticar o cliente.

Resposta Esperada

Em caso de sucesso, o endpoint devolve um objeto JSON contendo o token de autenticação (Bearer Token) e informações adicionais sobre a sessão ou o utilizador autenticado.

Nota: Guarde o token devolvido e utilize-o no header Authorization: Bearer nos pedidos seguintes que requeiram autenticação.

HEADERS

Accept
application/json

apikey
c8aac87a47bd979ebxc5e8cdvdb7248f1509

Chave de API fornecida

Example Request
                                                
GET https://api.preventech.pt/api/v2/authentication
                                            
GET Incidents List
https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList?date_from=13-08-2024&date_to=14-08-2024

Incidents List — Listagem de Ocorrências

Descrição

Este endpoint retorna a lista de ocorrências (incidentes) registadas no sistema GESCORP, permitindo filtrar por intervalo de datas.


Detalhes do Pedido

Campo Valor
Método GET
URL https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList

Parâmetros de Query

Parâmetro Obrigatório Formato Exemplo Descrição
date_from Não DD-MM-YYYY 13-08-2024 Data de início da Ocorrência
date_to Não DD-MM-YYYY 14-08-2024 Data de fim da Ocorrência

Notas

  • Os parâmetros date_from e date_to são opcionais.

  • As datas devem ser fornecidas no formato DD-MM-YYYY.

  • A resposta é devolvida em formato JSON.

HEADERS

Accept
application/json

PARAMS

date_from
13-08-2024

Data início da Ocorrência

date_to
14-08-2024

Data fim da Ocorrência

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList?date_from=13-08-2024&date_to=14-08-2024
                                            
GET Incidents List By ID
https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList/17663339

Incidents List By ID

Este endpoint permite obter a lista de incidentes associados a um registo específico, identificado pelo seu ID único.

Método HTTP: GET

URL: https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList/{id}

Parâmetro de Rota

Parâmetro Tipo Descrição
id integer Identificador único do registo para o qual se pretende consultar os incidentes. No exemplo, o valor utilizado é 17663339.

Cabeçalhos (Headers)

Chave Valor Descrição
Accept application/json Indica que a resposta deve ser devolvida no formato JSON.

Corpo do Pedido (Body)

Não aplicável. Este pedido não requer corpo.

Parâmetros de Consulta (Query Params)

Não aplicável. Este pedido não utiliza parâmetros de consulta.

Resposta Esperada

A resposta é devolvida em formato JSON e contém a lista de incidentes associados ao ID fornecido. Em caso de sucesso, o código de estado HTTP retornado será 200 OK.

HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList/17663339
                                            
GET Incidents Classifications List
https://api.preventech.pt/api/v2/gescorp/incidentsclassification/incidentsClassificationList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidentsclassification/incidentsClassificationList
                                            
GET Incidents Time Table List
https://api.preventech.pt/api/v2/gescorp/incidents/incidentsTimeTapeList?id_ocorrencia=17663339&tipo=comunicacao&origem=gescorp
HEADERS

Accept
application/json

PARAMS

id_ocorrencia
17663339

ID Ocorrência

tipo
comunicacao

Opções: comunicacao, posit

origem
gescorp

Opções: gescorp, sigmos

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidents/incidentsTimeTapeList?id_ocorrencia=17663339&tipo=comunicacao&origem=gescorp
                                            
GET Incidents Type State List
https://api.preventech.pt/api/v2/gescorp/incidentstypestate/incidentsTypeStateList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidentstypestate/incidentsTypeStateList
                                            
GET Incidents Mapping Tables List
https://api.preventech.pt/api/v2/gescorp/incidentsmappingtables/incidentsMappingTablesList?tabela=All
HEADERS

Accept
application/json

PARAMS

tabela
All

Opções: All, Source, Status, Parishes, Cities, Districts

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidentsmappingtables/incidentsMappingTablesList?tabela=All
                                            
PUT Update Incidents State
https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentState
HEADERS

Accept
application/json

BODY raw

                                                  
                                                    
{
    "id_ocorrencia": "17663339",
    "id_estado": "86"
}
                                                  
                                              
Example Request
                                                
PUT https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentState

{
    "id_ocorrencia": "17663339",
    "id_estado": "86"
}
                                            
PUT Update Incidents Vehicle
https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentsVehicle
HEADERS

Accept
application/json

BODY raw

Example Request
GET Incident Report By ID
https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList/17663339
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/incidents/incidentsList/17663339
                                            
PUT Update Incidents Report
https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentsReport
HEADERS

Accept
application/json

BODY raw

Example Request
PUT Update Incidents Coordinates
https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentCoordinates
HEADERS

Accept
application/json

BODY raw

                                                  
                                                    
{
    "id_ocorrencia": 17663374,
    "lat": "41.5000",
    "lon": "-7.6433"
}
                                                  
                                              
Example Request
                                                
PUT https://api.preventech.pt/api/v2/gescorp/incidents/updateIncidentCoordinates

{
    "id_ocorrencia": 17663374,
    "lat": "41.5000",
    "lon": "-7.6433"
}
                                            
POST Insert Incidents Time Tape Entry
https://api.preventech.pt/api/v2/gescorp/incidents/insertIncidentsTimeTape
HEADERS

Accept
application/json

BODY raw

Example Request
GET Requests List
https://api.preventech.pt/api/v2/gescorp/requests/requestsList?date_from=01-08-2024&date_to=12-12-2024

Requests List

Retorna a lista de pedidos registados no sistema, filtrada por um intervalo de datas e, opcionalmente, por tipo de pedido.

Método: GET
URL: https://api.preventech.pt/api/v2/gescorp/requests/requestsList


Parâmetros de Query

Parâmetro Obrigatório Descrição Exemplo
date_from Não Data de início do intervalo de pesquisa (formato: DD-MM-YYYY) 01-08-2024
date_to Não Data de fim do intervalo de pesquisa (formato: DD-MM-YYYY) 12-12-2024
tipo_pedido Não Filtra os pedidos por tipo. Se omitido, retorna todos os tipos. acidente

Valores possíveis para tipo_pedido

  • emergenciaph — Emergência Pré-Hospitalar

  • acidente — Acidente

  • incendio — Incêndio

  • transporte — Transporte

  • outros — Outros

  • fiscalizacao — Fiscalização


Headers

Header Valor
Accept application/json

HEADERS

Accept
application/json

PARAMS

date_from
01-08-2024

Data início do Pedido

date_to
12-12-2024

Data fim do Pedido

tipo_pedido
emergenciaph

Tipo de Pedido: emergenciaph,acidente,incendio,transporte,outros,fiscalizacao

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/requests/requestsList?date_from=01-08-2024&date_to=12-12-2024
                                            
GET Requests List By ID
https://api.preventech.pt/api/v2/gescorp/requests/requestsList/752983
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/requests/requestsList/752983
                                            
GET Firefighters List
https://api.preventech.pt/api/v2/gescorp/firefighters/firefightersList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/firefighters/firefightersList
                                            
GET Firefighters List By ID
https://api.preventech.pt/api/v2/gescorp/firefighters/firefightersList/33729
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/firefighters/firefightersList/33729
                                            
GET Entities List
https://api.preventech.pt/api/v2/gescorp/entities/entitiesList?email=api@gmail.com&nif=999999990&tipo=socio
HEADERS

Accept
application/json

PARAMS

email
api@gmail.com

Email

nif
999999990

NIF

tipo
socio

Opções: socio, particular, entidade

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/entities/entitiesList?email=api@gmail.com&nif=999999990&tipo=socio
                                            
GET Entities List By ID
https://api.preventech.pt/api/v2/gescorp/entities/entitiesList/649707?tipo=socio
HEADERS

Accept
application/json

PARAMS

tipo
socio

Opções: socio, particular, entidade

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/entities/entitiesList/649707?tipo=socio
                                            
GET Members List
https://api.preventech.pt/api/v2/gescorp/members/membersList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/members/membersList
                                            
GET Members Payment Method List
https://api.preventech.pt/api/v2/gescorp/members/membersPaymentMethodList
HEADERS

Accept
application/json

BODY raw

                                                  
                                                    
{
    "email": "cesmatos@gmail.com",
    "nif": "232566020"
}
                                                  
                                              
Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/members/membersPaymentMethodList

{
    "email": "cesmatos@gmail.com",
    "nif": "232566020"
}
                                            
GET Members Payment Type List
https://api.preventech.pt/api/v2/gescorp/members/membersPaymentTypeList
HEADERS

Accept
application/json

BODY raw

                                                  
                                                    
{
    "email": "cesmatos@gmail.com",
    "nif": "232566020"
}
                                                  
                                              
Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/members/membersPaymentTypeList

{
    "email": "cesmatos@gmail.com",
    "nif": "232566020"
}
                                            
GET Members List By ID
https://api.preventech.pt/api/v2/gescorp/members/membersList/423451
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/members/membersList/423451
                                            
POST Member Fees Payment
https://api.preventech.pt/api/v2/gescorp/incidents/memberFeesPayment
HEADERS

Accept
application/json

BODY raw

Example Request
GET Vehicles List
https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesList
                                            
GET Vehicles List GPS
https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesGPS
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesGPS
                                            
GET Vehicles List By ID
https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesList/77
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/vehicles/vehiclesList/77
                                            
POST Insert Victim
https://api.preventech.pt/api/v2/gescorp/victims/insertVictim
HEADERS

Accept
application/json

BODY raw

Example Request
GET Victims Position List
https://api.preventech.pt/api/v2/gescorp/victimsposition/victimsPositionList
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/victimsposition/victimsPositionList
                                            
GET Victims List
https://api.preventech.pt/api/v2/gescorp/victims/victimsList?id_ocorrencia=17681505&id_viatura=79
HEADERS

Accept
application/json

PARAMS

id_ocorrencia
17681505

ID Ocorrência

id_viatura
79

ID Viatura

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/victims/victimsList?id_ocorrencia=17681505&id_viatura=79
                                            
GET Victims List By ID
https://api.preventech.pt/api/v2/gescorp/victims/victimsList/6622175
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gescorp/victims/victimsList/6622175
                                            
GET Biometric Records List
https://api.preventech.pt/api/v2/biometricsrecords/recordsList?date_from=25-03-2025&hour_from=13:00&date_to=25-03-2025&hour_to=15:00&tipo=in
HEADERS

Accept
application/json

PARAMS

date_from
25-03-2025

hour_from
13:00

date_to
25-03-2025

hour_to
15:00

tipo
in

in,out

Example Request
                                                
GET https://api.preventech.pt/api/v2/biometricsrecords/recordsList?date_from=25-03-2025&hour_from=13:00&date_to=25-03-2025&hour_to=15:00&tipo=in
                                            
POST SendSMS
https://api.preventech.pt/api/v2/gescorp/sms/sendsms
HEADERS

Accept
application/json

BODY raw

Example Request
GET Incidents List SIGMOS
https://api.preventech.pt/api/v2/sigmos/incidents/incidentsList?date_from=13-08-2024&date_to=14-08-2024

Incidents List — Listagem de Ocorrências

Descrição

Este endpoint retorna a lista de ocorrências (incidentes) registadas no sistema SIGMOS, permitindo filtrar por intervalo de datas.


Detalhes do Pedido

Campo Valor
Método GET
URL https://api.preventech.pt/api/v2/sigmos/incidents/incidentsList

Parâmetros de Query

Parâmetro Obrigatório Formato Exemplo Descrição
date_from Não DD-MM-YYYY 13-08-2024 Data de início da Ocorrência
date_to Não DD-MM-YYYY 14-08-2024 Data de fim da Ocorrência

Notas

  • Os parâmetros date_from e date_to são opcionais.

  • As datas devem ser fornecidas no formato DD-MM-YYYY.

  • A resposta é devolvida em formato JSON.

HEADERS

Accept
application/json

PARAMS

date_from
13-08-2024

Data início da Ocorrência

date_to
14-08-2024

Data fim da Ocorrência

Example Request
                                                
GET https://api.preventech.pt/api/v2/sigmos/incidents/incidentsList?date_from=13-08-2024&date_to=14-08-2024
                                            
GET Incidents List SIGMOS PROCIV
https://api.preventech.pt/api/v2/sigmos/incidents/incidentsListPROCIV
HEADERS

Accept
application/json

BODY raw

                                                  
                                                    
{
    "date_from": "10-04-2024",
    "date_to": "10-04-2024"
}
                                                  
                                              
Example Request
                                                
GET https://api.preventech.pt/api/v2/sigmos/incidents/incidentsListPROCIV

{
    "date_from": "10-04-2024",
    "date_to": "10-04-2024"
}
                                            
GET Incidents List By ID SIGMOS
https://api.preventech.pt/api/v2/sigmos/incidents/incidentsList/192291
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/sigmos/incidents/incidentsList/192291
                                            
GET Incidents List
https://api.preventech.pt/api/v2/gesprociv/incidents/incidentsList?date_from=10-12-2025&date_to=10-12-2025

Incidents List — Listagem de Ocorrências

Descrição

Este endpoint retorna a lista de ocorrências (incidentes) registadas no sistema GESPROCIV, permitindo filtrar por intervalo de datas.


Detalhes do Pedido

Campo Valor
Método GET
URL https://api.preventech.pt/api/v2/gesprociv/incidents/incidentsList

Parâmetros de Query

Parâmetro Obrigatório Formato Exemplo Descrição
date_from Não DD-MM-YYYY 13-08-2024 Data de início da Ocorrência
date_to Não DD-MM-YYYY 14-08-2024 Data de fim da Ocorrência

Notas

  • Os parâmetros date_from e date_to são opcionais.

  • As datas devem ser fornecidas no formato DD-MM-YYYY.

  • A resposta é devolvida em formato JSON.

HEADERS

Accept
application/json

PARAMS

date_from
10-12-2025

Data início da Ocorrência

date_to
10-12-2025

Data fim da Ocorrência

Example Request
                                                
GET https://api.preventech.pt/api/v2/gesprociv/incidents/incidentsList?date_from=10-12-2025&date_to=10-12-2025
                                            
GET Incidents List By ID
https://api.preventech.pt/api/v2/gesprociv/incidents/incidentsList/17663339
HEADERS

Accept
application/json

Example Request
                                                
GET https://api.preventech.pt/api/v2/gesprociv/incidents/incidentsList/17663339