Ronda senior X - Manual do Usuário > Integrações > Integrações com outros sistemas > Integrar eventos

Integração de eventos utilizando a API

Documentação de como realizar a integração dos eventos, utilizando a API do Ronda senior X.

Pré-requisitos gerais

Estar autenticado no Ronda senior X;
Passar o token no Header.

Consultar eventos descartados

Chame o serviço GET /rejectedEvent/pagedsearch/all para consultar os eventos por periodo;
No postman, os seguintes itens devem ser passados na URL (query) por parâmetro: order (1 = crescente, 0 = decrescente), type (0 = acesso, 1 = alarme, 2 = notificação), dataInicio, dataFim, pagina, totalPaginas: https://sam-api.senior.com.br/api/v1/rejectedEvent/pagedsearch/all?order=0&type=0&startDate=2017-03-27T00:00:00-03:00&endDate=2017-03-27T21:55:00-03:00&page=1&pageSize=10

Consultar eventos de acesso e eventos de alarmes

Chamar o serviço POST /monitoring/access/pagesearch/all para consultar os eventos de acesso;
Os filtros podem ser realizados por data inicial e final, tipo de acesso, local físico, dispositivos, grupos, pessoas e papéis, conforme tipos abaixo:

Informações dos serviços

GET /rejectedEvent/pagedsearch/all

Implementation Notes

Return an all rejected events

Response Class (Status 200)

Return an rejected event

{
  "datetime": "string",
  "eventType": 0,
  "rejectReason": "string",
  "device":
  {
    "id": 0,
    "name": "string",
    "deviceType": 0
  },
  "credential": 0,
  "cardNumber": 0,
  "personId": 0,
  "biometricManufacturer": 0,
  "credentialFormat": "CARD"
}

Parameters

Parameter	Description	Parameter Type	Data Type
X-JWT-Assertion	WSO2 JWT token	header	string
X-Authenticated-Userid	The logged-in user ID	header	string
order	Order filter (1 for ascending order, 0 for descending order)	query	integer
type	Rejected event type filter (0 = ACCESS, 1 = ALARM , 2 = NOTIFICATION)	query	string
startDate	Start date	query	string
endDate	End date	query	string
page	Page number	query	integer
pageSize	Size of page	query	integer

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{ "id": "string", "code": 0, "message": "string" }

POST /monitoring/access/pagesearch/all

Implementation Notes

Return a array of all monitored access filtered

Response Class (Status 200)

Return a list of all monitored access

{
  "date": "string",
  "credential": 0,
  "person": {
    "id": 0,
    "name": "string",
    "mandatoryDocuments": [
      {
        "id": 0,
        "documentType": {
          "id": 0,
          "name": "string",
          "label": "string",
          "mask": "string",
          "required": true,
          "documentToREP": true
        },
        "document": "string"
      }
    ],
    "preferentialEmail": {
      "id": 0,
      "preferential": true,
      "emailAddress": "string"
    },
    "preferentialPhone": {
      "id": 0,
      "preferential": true,
      "ddi": 0,
      "phoneNumber": "string",
      "extensionLine": "string",
      "type": "UNDEFINED"
    },
    "lastFeedbackPollDate": "string",
    "useSelfServiceTerminal": true
  },
  "accessType": "string",
  "physicalLocationDestiny": {
    "id": 0,
    "name": "string"
  },
  "device": {
    "id": 0,
    "name": "string",
    "deviceType": 0,
    "readerTechnology": 0
  },
  "devicePhysicalLocation": {
    "id": 0,
    "name": "string"
  },
  "biometricManufacturer": 0,
  "credentialFormat": "CARD",
  "status": "OFFLINE",
  "accessDirection": "ENTRANCE"
}

Parameters

Parameter	Description	Parameter Type	Data Type
X-JWT-Assertion	WSO2 JWT token	header	string
X-Authenticated-Userid	The logged-in user ID	header	string
Monitoring Search	Monitoring Search	body	MonitoringSearch { "startDate": "string", "endDate": "string", "typeAccess": 0, "order": 0, "page": 0, "pageSize": 0, "physicalLocation": [ 0 ], "devices": [ 0 ], "groups": [ 0 ], "persons": [ 0 ], "roles": [ 0 ] }

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{ "id": "string", "code": 0, "message": "string" }

PORTAL DE DOCUMENTAÇÃO
Ronda senior X