Acesso e Segurança (sam)

2.0info: 1.0.0 Ronda senior X SDK APIhost: sam-api.senior.com.br /sdk/v1schemes: – http – httpsparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br) paths: /device/biometry: post: summary: Cadastro de biometria tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: includeBiometry description: Nova biometria required: true schema: #/definitions/IncludeBiometry responses: 200: description: Biometria adicionada 401: description: O driver_key ou partner_key são inválidos 404: description: Pessoa não encontrada 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/biometry: get: description: Retorna a lista de pessoas, suas templates e a lista de cartões ativos. summary: Biometrias tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: query name: personId description: Identificador da pessoa required: false type: integer format: int64 – in: query name: cardNumber description: Número do cartão required: false type: integer format: int64 – in: query name: manufacturer description: Fabricante biométrico required: false type: string enum: – FINGERPRINT_SAGEM – FINGERPRINT_SUPREMA – FINGERPRINT_VIRDI – FINGERPRINT_NITGEN – FINGERPRINT_CAMA – FINGERPRINT_INNOVATRICS – HANDKEY_IR – FACIAL – in: query name: startDate description: Busca biometrias atualizadas a partir desta data required: false type: string responses: 200: description: Retorna listas de biometrias formatadas em Base64 schema: type: array items: #/definitions/PersonTemplates 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/cardformat: get: description: O formato de cartão define como os dados do cartão serão lidos. summary: Formatos de cartão tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna uma lista de formatos de cartão schema: type: array items: #/definitions/CardFormatList 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/areacontrol: get: summary: Locais e suas configurações tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna uma lista de locais e suas configurações schema: type: array items: #/definitions/AreaControlList 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/accesslevel: get: description: Retorna uma lista de níveis de acesso, são leitoras onde o papel tem permissão para acessar. Utilizado somente para o fabricante Apollo. summary: Níveis de acesso tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna uma lista de níveis de acesso schema: type: array items: #/definitions/AccessLevelList 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/holiday: get: summary: Feriados tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna listas de feriados (ISO 8601) schema: type: array items: #/definitions/HolidayList 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/timezone: get: summary: Faixas horária tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação do driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna uma lista de faixa horária schema: type: array items: #/definitions/TimezoneList 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/person/photo: get: summary: Pessoa, sua foto e seus cartões – deprecado deprecated: true description: Deprecado utilize /datamart/person/info tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: query name: managerDeviceId description: Identificador do dispositivo gerenciador required: true type: integer format: int64 – in: query name: cardNumber description: Número do cartão required: true type: integer format: int64 responses: 200: description: Retorna pessoa, sua foto e cartões schema: #/definitions/PersonPhoto 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /datamart/person/info: get: summary: Informações de pessoa tags: – Datamart – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: query name: managerDeviceId description: Identificador do dispositivo gerenciador required: true type: integer format: int64 – in: query name: cardNumber description: Número do cartão required: false type: integer format: int64 – in: query name: personId description: Identificador da pessoa required: false type: integer format: int64 responses: 200: description: Retorna pessoa, sua foto e cartões schema: #/definitions/PersonInfo 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /driver: get: summary: Driver associado ao driverKey tags: – Driver – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna o driver associado ao driverKey e suas propriedades schema: #/definitions/Driver 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /driver/datetime: get: summary: Data e horário tags: – Driver – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna data e horário (ISO 8601) schema: #/definitions/DriverDateTime 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /driver/manufacturer: post: summary: Informa para o sistema, o nome do fabricante do driver que está usando essa chave tags: – Driver – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: driver_manufacturer description: Nome do fabricante do driver required: true schema: #/definitions/DriverManufacturer responses: 200: description: Nome do fabricante do driver atualizado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /driver/status: post: summary: Alteração do status do driver tags: – Driver – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: driverStatusInput description: Informação de status do driver required: true schema: #/definitions/DriverStatusInput responses: 200: description: Driver status alterado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /pendency/success: post: summary: Atualiza status da pendência como executada com sucesso tags: – Pendency – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: id description: Lista de pendências required: true schema: type: array items: #/definitions/PendencyExecuted responses: 200: description: Todas as pendências foram marcadas como concluídas 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /pendency/update: post: summary: Remove ou atualiza as pendências description: O atributo operation informa se a pendência deve ser removida ou mantida para execução. tags: – Pendency – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: id description: Lista de pendências required: true schema: type: array items: #/definitions/PendencyUpdated responses: 200: description: Todas as pendências foram alteradas 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /pendency/: get: summary: Pendências description: O serviço retornará diferentes tipos de listas de pendências que necessitam ser processadas pelo driver do parceiro, algumas pendências são obrigatórias dependendo do tipo de dispositivo. tags: – Pendency – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna todas as pendências schema: #/definitions/AllPendency 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /pendency/device/{id}: get: summary: Pendências do dispositivo description: Retorna uma lista de pendências para o dispositivo informado. As pendências devem ser processadas pelo driver do parceiro. tags: – Pendency – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo required: true type: integer format: int64 responses: 200: description: Retorna todas as pendências do dispositivo schema: #/definitions/AllPendency 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/accessrequest: post: description: A requisição de acesso de pessoa poderá ser feita com cartão da pessoa ou com Id da pessoa. /br b Requisição por cartão: /b O campo cardId deve estar preenchido com o número do cartão da pessoa. /br b Validação de acesso com Id da pessoa: /b Quando a digital ou foto da pessoa é localizada no dispositivo, a requisição de acesso deve ser realizada informando o Id da pessoa relacionada no campo personId. /br /br b Retorno: /b Tipo do acesso, se o dispositivo deve exigir a validação biométrica da pessoa e o Id do local físico de onde a pessoa está. summary: Requisição de acesso de pessoa tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: access_request description: Requisição de acesso required: true schema: #/definitions/AccessRequest responses: 200: description: Resposta da requisição schema: #/definitions/PersonValidationResponse 401: description: O driver_key ou partner_key são inválidos 404: description: Pessoa ou cartão não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/accessrequest/healthcheck: get: description: Pode ser utilizado para monitorar o funcionamento da requisição de acesso. summary: Status da requisição de acesso tags: – Healthcheck – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Retorna status da requisição de acesso schema: #/definitions/HealthcheckResponse 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/accessrequest/vehicle: post: description: A requisição de acesso com credenciais do veículo pode ocorrer das seguintes formas: /br – Placa do veículo /br – Cartão do veículo /br – Placa do veículo e cartão do condutor do veículo /br – Placa do veículo e identificador do condutor do veículo /br – Cartão do veículo e cartão do condutor do veículo /br – Cartão do veículo identificador do condutor do veículo /br Utilizando apenas a credencial do veículo (cartão ou placa), poderá ocorrer acesso permitido, acesso negado por algum motivo ou acesso negado aguardando a credencial do condutor, indicando que deve realizar a dupla validação. /br Para realizar a dupla validação o driver do parceiro deverá chamar novamente o serviço passando as credenciais do veículo e do condutor (cartão ou identificador da pessoa). Nesse caso poderá retornar acesso permitido ou acesso negado por algum motivo. /br Os eventos de acesso com credenciais de veículos devem ser enviados para SDK API chamando o serviço /notify/vehicle/access. summary: Requisição de acesso de veículo tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: access_request description: Requisição de Acesso required: true schema: #/definitions/VehicleAccessRequest responses: 200: description: Resposta de validação schema: #/definitions/ValidationResponse 401: description: O driver_key ou partner_key são inválidos 404: description: Requisição de acesso não encontrada 500: description: Erro de servidor schema: #/definitions/ErrorResponse /lpr/accessrequest: post: summary: Requisição de acesso por placa de veículo description: Valida requisição apenas por placa de veículo. tags: – LPR – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: access_request description: AccessRequest required: true schema: #/definitions/LprAccessRequest responses: 200: description: Resposta da validação schema: #/definitions/LprValidationResponse 401: description: O driver_key ou partner_key são inválidos 404: description: Leitora não encontrada 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/accessrequest/qrcode: post: summary: Validação de acesso usando QRCode description: O campo qrcode deverá ser preenchido com o conteúdo extraído da imagem do QRCode. /br Retorno: O driver do parceiro receberá o tipo do acesso, se o dispositivo deve exigir a validação biométrica da pessoa e o identificador do local físico de onde a pessoa está. tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: accessRequest description: Requisição de acesso required: true schema: #/definitions/QRCodeAccessRequest responses: 200: description: Resposta da requisição schema: #/definitions/PersonValidationResponse 401: description: O driver_key ou partner_key são inválidos. 403: description: Permissão negada 404: description: QRCode não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/{id}/card: get: description: Lista de cartões com acesso liberado no dispositivo. Utilizado somente para o fabricante Apollo. summary: Lista de cartões tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo required: true type: integer format: int64 responses: 200: description: Lista de cartões schema: type: array items: #/definitions/Card 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/rep/{id}/credential: get: summary: Credenciais com acesso ao REP tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo required: true type: integer format: int64 responses: 200: description: Retorna a lista de credenciais com acesso ao REP schema: type: array items: #/definitions/PersonRep 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/access/{id}/card: get: summary: Cartões liberados para o dispositivo tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do Dispositivo required: true type: integer format: int64 responses: 200: description: Cartões que possuem permissão para acessar este dispositivo schema: type: array items: #/definitions/CardList 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/access/{id}/biometry: get: summary: Biometrias liberadas para o dispositivo tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo required: true type: integer format: int64 responses: 200: description: Biometrias liberados para o dispositivo schema: type: array items: #/definitions/AccessBiometry 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/collect/status: post: summary: Atualiza status de coleta de eventos tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: status description: Status do dispositivo de entrada required: true schema: #/definitions/CollectEventStatus responses: 200: description: Adicionado o status da coleta 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/input/status: post: summary: Atualizar o status da entrada tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: status description: Status da entrada do dispositivo required: true schema: #/definitions/DeviceInputStatus responses: 200: description: Status da entrada adicionado 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo ou entrada não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/status: post: summary: Atualiza o status do dispositivo tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: status description: Status do dispositivo required: true schema: #/definitions/DeviceStatus responses: 200: description: Status adicionado 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/{id}: get: summary: Dispositivo gerenciador e seus filhos tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo required: true type: integer format: int64 responses: 200: description: Retorna o dispositivo gerenciador e seus filhos schema: #/definitions/ManagerDevice 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device: get: summary: Dispositivos gerenciadores e seus dispositivos filhos tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Dispositivos gerenciadores e seus dispositivos filhos schema: type: array items: #/definitions/ManagerDevice 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /device/access/{id}/photo: get: summary: Fotos de faces liberadas para acessar o dispositivo description: Busca URL das fotos das faces das pessoas liberadas para acessar o dispositivo. tags: – Device – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: path name: id description: Identificador do dispositivo gerenciador required: true type: integer format: int64 responses: 200: description: Foto das pessoas liberadas schema: type: array items: #/definitions/PersonPhotoTemplates 401: description: O driver_key ou partner_key são inválidos 404: description: Dispositivo não encontrado 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/input/alarm: post: summary: Notifica alarmes description: O campo deviceId será o identificador de uma entrada. O campo inputState indica se a entrada está alarmada (ACTIVE) ou não (INACTIVE) /br A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: Alarm description: Alarme required: true schema: type: array items: #/definitions/Alarm responses: 200: description: Alarme processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/device/event: post: summary: Notifica os eventos do dispositivo description: O campo deviceId será o identificador de um gerenciador ou módulo. O campo eventType define o tipo de evento ocorrido. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: Event description: Evento required: true schema: type: array items: #/definitions/Event responses: 200: description: Evento processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/device/resource: post: summary: Notifica os recursos do dispositivo description: O campo deviceId será o identificador de um gerenciador. O campo resourceType é o tipo de recurso e o campo resourcePercent é o percentual de uso do recurso. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: Resource description: Recurso required: true schema: type: array items: #/definitions/Resource responses: 200: description: Recurso processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/vehicle/access: post: summary: Notifica o acesso de veículos description: O campo vehicleCardId é o número físico do crachá do veículo. O campo accessType informa se o acesso foi permitido ou motivo pelo qual foi negado. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: VehicleAccess description: Veículo de Acesso required: true schema: type: array items: #/definitions/VehicleAccess responses: 200: description: Lote de acessos processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/healthcheck: get: summary: Estado de disponibilidade dos serviços de notificação tags: – Healthcheck – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: Estado de disponibilidade schema: #/definitions/HealthcheckResponse 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/person/access: post: summary: Notificação de acessos da pessoa description: Neste serviço, existe o campo cardId e personId, se o cardId for enviado, a pessoa precisa ter uma credencial de cartão e personId dever ser 0. Se for enviado o personId, a pessoa precisa ter uma credencial biométrica e campo cardId deve ser zero. O campo deviceId será o identificador de uma leitora. O campo accessType é o tipo de acesso realizado e o campo accessDirection é a direção do acesso. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: Access description: Acesso required: true schema: type: array items: #/definitions/Access responses: 200: description: Acesso processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/person/event: post: summary: Notifica o evento de pessoa description: O campo personId é o identificador de pessoa. O campo deviceId é o identificador do dispositivo. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. O campo normalTemperature informa se a temperatura da pessoa é normal. O campo temperature traz o valor da temperatura. O campo withMask informa se a pessoa está com máscara. O campo accessAllowed informa se o acesso foi permitido. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: PersonEvent description: Evento de pessoa required: true schema: type: array items: #/definitions/PersonEvent responses: 200: description: Acesso processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/person/clockin: post: summary: Notifica pontos description: Utilizado para notificação de marcações de ponto (REP). O campo deviceId será o identificador de uma leitora. O campo pis é o PIS da pessoa que realizou o acesso e o campo nsr o número sequencial de registro na memória do REP referente a marcação de ponto. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: ClockIn description: Ponto required: true schema: type: array items: #/definitions/ClockIn responses: 200: description: Ponto processado 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponse /notify/qrcode/access: post: summary: Notifica os acessos por QRCode description: O campo deviceId será o identificador de uma leitora. O campo qrcode deverá ser preenchido com o conteúdo extraído da imagem do QRCode. O campo accessType é o tipo de acesso realizado e o campo accessDirection é a direção do acesso. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: accessNotifications description: Notificações de acesso por QRCode required: true schema: type: array items: #/definitions/QRCodeAccessNotification responses: 200: description: Notificações de acesso recebidas 401: description: O driver_key ou partner_key são inválidos. 500: description: Erro de servidor. schema: #/definitions/ErrorResponse /notify/bluetooth/access: post: summary: Notifica os acessos por Bluetooth description: O campo deviceId será o identificador de uma leitora. O campo credentialId será o identificador da credencial da pessoa. O campo accessType é o tipo de acesso realizado e o campo accessDirection é a direção do acesso. A data (campo date) enviada sempre deverá estar no GMT-0, e offset do GMT (campo timezoneOffset) será o GMT da configuração do dispositivo (em minutos) ajustado em relação ao horário de verão. tags: – Notification – application/json – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string – in: body name: bluetoothAccessNotifications description: Bluetooth access notifications. required: true schema: type: array items: #/definitions/BluetoothAccessNotification responses: 200: description: Notificações de acesso recebidas 401: description: O driver_key ou partner_key são inválidos. 500: description: Erro de servidor. schema: #/definitions/ErrorResponse /server/status: get: summary: Status do servidor tags: – Server – application/json parameters: – #/parameters/clientId – in: header name: partner_key description: Chave de identificação do parceiro required: false type: string – in: header name: driver_key description: Chave de identificação de driver required: false type: string – in: header name: api_key deprecated: true description: Deprecado, use o parâmetro driver_key required: false type: string responses: 200: description: O servidor está OK 401: description: O driver_key ou partner_key são inválidos 500: description: Erro de servidor schema: #/definitions/ErrorResponsedefinitions: Device: type: object properties: id: description: Identificador do dispositivo type: integer format: int64 areaId: description: Identificador da área type: integer format: int64 ManagerDevice: type: object allOf: – #/definitions/Device – properties: networkIdentification: description: Endereço de rede type: string networkPort: description: Porta type: integer deviceType: #/definitions/DeviceType displayMessage: description: Mensagem do display type: string numberOfCardRecords: description: Quantidade de crachás controlados: informa a quantidade máxima de crachás que serão controlados simultaneamente. Campo disponível somente para dispositivos Apollo type: integer turnstileBypassTime: description: Tempo burla catraca em segundos: indica o tempo que deve passar para gerar um evento de burla catraca. Campo disponível somente para dispositivos de controle de acesso (Apollo ou SDK) type: integer module: type: array description: Módulo items: #/definitions/ModuleDevice reader: description: Leitora type: array items: #/definitions/ReaderDevice output: description: Dispositivo de saída type: array items: #/definitions/OutputDevice intput: description: Dispositivo de entrada type: array items: #/definitions/InputDevice accessMessage: description: Mensagem de acesso: informa o texto que aparecerá no visor do dispositivo quando cada evento de acesso ocorrer. As mensagens estão disponíveis somente para dispositivos de controle de acesso (Apollo ou SDK) type: array items: #/definitions/AccessMessage portConfiguration: description: Configuração da porta type: array items: #/definitions/PortConfiguration repConfiguration: #/definitions/RepConfiguration extensibleConfiguration: #/definitions/ExtensibleConfiguration AccessMessage: type: object properties: accessType: #/definitions/AccessType message: type: string PortConfiguration: type: object properties: id: type: integer format: int64 portNumber: description: Número da Porta type: integer communicationMode: #/definitions/CommunicationMode txdDriverSettleDelay: description: Delay do driver txd type: integer receiveDataValidDelay: description: Delay do driver rxd type: integer interCharacterTimeout: description: Timeout recebimento type: integer controllerReplyTimeout: description: Timeout reposta type: integer pollTime: description: Timeout eventos type: integer offlineDevicePollTime: description: Timeout eventos offline type: integer RepConfiguration: description: Propriedades do REP type: object properties: id: type: integer format: int64 companyName: description: Nome da empresa type: string cnpj: type: string cpf: type: string cei: type: string address: description: Endereço type: string taxNumber: type: string ModuleDevice: type: object allOf: – #/definitions/Device – properties: deviceType: #/definitions/DeviceType address: description: Endereço type: integer portNumber: description: Número da porta type: integer reader: description: Leitora type: array items: #/definitions/ReaderDevice output: description: Dispositivo de saída type: array items: #/definitions/OutputDevice intput: description: Dispositivo de entrada type: array items: #/definitions/InputDevice ReaderDevice: type: object allOf: – #/definitions/Device – properties: output: description: Dispositivo de saída type: array items: #/definitions/OutputDevice intput: description: Dispositivo de entrada type: array items: #/definitions/InputDevice readerTechnology: #/definitions/ReaderTechnology readerDirection: #/definitions/ReaderDirection biometricManufacturer: #/definitions/BiometricManufacturer biometricValidation: #/definitions/BiometricValidation biometricSecurityLevel: description: Nível de conferência type: integer biometricReaderId: description: Leitora biométrica que será utilizado por este leitor para validar a biometria 1:1 type: integer format: int64 physicalAddress: description: Endereço type: integer areaLeaving: description: Local físico de origem type: integer format: int64 areaEntering: description: Local físico de destino type: integer format: int64 cardFormatList: description: Lista de formato de cartão type: array items: type: integer format: int64 strikeTime: description: Tempo type: integer heldOpenTime: description: Tempo aberto type: integer offlineMode: #/definitions/ReaderMode accessMode: #/definitions/ReaderMode antiPassbackTime: description: É o tempo mínimo de acesso para o mesmo destino, a fim de evitar que duas pessoas utilizem o mesmo cartão para acessar o mesmo local type: integer enablePairing: description: Ativa o emparelhamento type: boolean validateVehicle: description: Valida veículo type: boolean activations: type: array description: Leitoras ativas items: #/definitions/ReaderActivation extensibleConfiguration: #/definitions/ExtensibleConfiguration urnSensor: description: Identificador do sensor de urna type: integer format: int64 urnSensorTime: description: Tempo sensor urna type: integer ReaderActivation: type: object properties: actionEventType: type: integer description: 0=Acesso Permitido, 1=Acesso Negado outputId: type: integer format: int64 activationTime: type: integer description: Quantidade em milissegundos de tempo em que a ativação será executada (zero é para sempre) InputDevice: type: object allOf: – #/definitions/Device – properties: address: description: Endereço type: integer defaultState: #/definitions/InputOutputState activationDelay: description: Atraso de ativação type: integer masking: type: array description: Máscaras items: #/definitions/Masking activations: type: array description: Entradas ativas items: #/definitions/InputActivation extensibleConfiguration: #/definitions/ExtensibleConfiguration InputActivation: type: object properties: outputId: type: integer format: int64 activationTime: type: integer description: Quantidade em milissegundos de tempo em que a ativação será executada (zero é para sempre) OutputDevice: type: object allOf: – #/definitions/Device – properties: address: description: Endereço type: integer defaultState: #/definitions/InputOutputState extensibleConfiguration: #/definitions/ExtensibleConfiguration PendencyExecuted: type: object properties: pendencyId: description: Identificador da pendência type: integer format: int64 DriverStatusInput: type: object properties: driverIds: type: array items: type: integer format: int64 CredentialOwnerType: type: string description: Tipo do proprietário enum: – PERSON – VEHICLE Card: type: object properties: cardNumber: description: Número físico do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology startValidity: description: Data de início da validade type: string format: date-time finishValidity: description: Data final da validade type: string format: date-time checkAntiPassback: description: Valida anti-dupla type: boolean ownerType: #/definitions/CredentialOwnerType ownerId: description: Identificador do proprietário da credencial (pessoa ou veículo) type: integer format: int64 areaId: description: Identificador da área type: integer format: int64 isVisitor: description: Informa se é um visitante type: boolean isEscort: description: Informa se é um autorizador type: boolean accessLevel: description: Níveis de acesso type: array items: type: integer format: int64 CardRep: type: object properties: cardNumber: description: Número físico do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology PersonRep: type: object properties: id: type: integer format: int64 name: description: Nome da pessoa type: string pis: description: Documento type: integer format: int64 verifyBiometrics: description: Tipo da validação para biometria = [NOT_VALID_BIOMETRY, VALID_CARD_AND_BIOMETRY, ONLY_VALID_BIOMETRY] type: integer cards: description: Lista de cartão type: array items: #/definitions/CardRep biometries: description: Lista de biometrias type: array items: #/definitions/Biometry CardList: type: object properties: cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology reader: description: Leitoras que o cartão possui acesso type: array items: type: integer ownerType: #/definitions/CredentialOwnerType ownerId: description: Identificador do proprietário da credencial (pessoa ou veículo) type: integer format: int64 Driver: type: object properties: id: type: integer format: int64 name: description: Descrição type: string requestIntervalTime: description: Intervalo de tempo entre consultas (milissegundos) type: integer waitInterval: description: Intervalo de espera (milissegundos) type: integer sendCardholders: description: Informa se deverá enviar as credenciais para o driver. (Apenas driver Apollo) type: boolean packetSize: description: Tamanho do pacote type: integer extensibleConfiguration: #/definitions/ExtensibleConfiguration PendencyUpdated: type: object properties: pendencyId: description: Identificador da pendência type: integer format: int64 errorCode: description: Código de erro type: integer operation: type: string default: REMOVE_PENDENCY enum: – REMOVE_PENDENCY – KEEP_PENDENCY StatusField: type: object properties: key: type: string value: type: string InputStatusField: type: object properties: inputDeviceId: description: Identificador do dispositivo type: integer format: int64 status: type: string enum: – DEACTIVATE – ACTIVATE DriverDateTime: type: object properties: dateTime: type: string DeviceInputStatus: type: object allOf: – #/definitions/DevicePendency – properties: status: description: Status da entrada type: array items: #/definitions/InputStatusField DeviceStatus: type: object allOf: – #/definitions/DevicePendency – properties: status: type: array items: #/definitions/StatusField Pendency: type: object properties: pendencyId: description: Identificador da pendência type: integer format: int64 DevicePendency: type: object allOf: – #/definitions/Pendency – properties: managerDeviceId: description: Identificador do dispositivo gerenciador type: integer format: int64 DriverPendency: type: object allOf: – #/definitions/Pendency – properties: driverId: description: Identificador do driver type: integer format: int64 DatamartUpdatedPendency: type: object allOf: – #/definitions/DriverPendency – properties: datamartObjectType: #/definitions/DatamartObjectType NotificationStatus: description: Status da notificação type: string default: ONLINE enum: – ONLINE – OFFLINE Notification: type: object properties: deviceId: description: Identificador do dispositivo type: integer format: int64 date: description: Data da notificação em UTC type: string format: date-time timezoneOffset: description: Offset em minutos type: integer status: #/definitions/NotificationStatus ApolloIncludeCardPendency: type: object allOf: – #/definitions/DevicePendency – #/definitions/Card IncludeCardPendency: type: object allOf: – #/definitions/DevicePendency – properties: cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology readerIdList: description: Lista das leitoras onde o cartão possui permissão type: array items: type: integer ownerType: #/definitions/CredentialOwnerType ownerId: description: Identificador do proprietário da credencial (pessoa ou veículo) type: integer format: int64 DisplayMessageMode: type: string enum: – ENQUEUE – OVERRIDE DeviceDisplayMessagePendency: type: object allOf: – #/definitions/DevicePendency – properties: message: description: Mensagem type: string maxLength: 128 duration: description: Duração do tempo de exibição da mensagem (precisão de milissegundos) type: integer format: int64 mode: #/definitions/DisplayMessageMode BlockDevicePendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 SetDeviceEmergencyPendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 UnsetDeviceEmergencyPendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 UnblockDevicePendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 ActiveDeviceOutputPendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 activationTime: description: Tempo de ativação em milissegundos type: integer format: int64 DeactiveDeviceOutputPendency: type: object allOf: – #/definitions/DevicePendency – properties: deviceId: description: Identificador do dispositivo type: integer format: int64 ApolloExcludeCardPendency: type: object allOf: – #/definitions/DevicePendency – properties: card: description: Número do cartão type: integer format: int64 personId: description: Identificador da pessoa type: integer format: int64 ExcludeCardPendency: type: object allOf: – #/definitions/DevicePendency – properties: card: description: Número do cartão type: integer format: int64 IncludeBiometryPendency: type: object allOf: – #/definitions/DevicePendency – properties: personId: description: Identificador da pessoa type: integer format: int64 cardList: description: Lista de credenciais type: array items: #/definitions/CardAndTechnology biometry: #/definitions/Biometry ExcludeBiometryPendency: type: object allOf: – #/definitions/DevicePendency – properties: personId: description: Identificador da pessoa type: integer format: int64 cardList: description: Lista de cartões type: array items: #/definitions/CardAndTechnology LoadHolidayListPendency: type: object allOf: – #/definitions/DevicePendency – properties: holidayListId: description: Identificador da lista de feriados type: integer format: int64 DeviceUpdatedPendency: type: object allOf: – #/definitions/DevicePendency – properties: operation: description: Status do dispositivo type: string default: DEVICE_CREATED enum: – DEVICE_CREATED – DEVICE_UPDATED – DEVICE_REMOVED – DEVICE_CONFIG CollectEventStatus: type: object allOf: – #/definitions/DevicePendency – properties: accessEventCount: type: integer format: int64 alarmEventCount: type: integer format: int64 PersonAreaUpdatedPendency: type: object allOf: – #/definitions/DevicePendency – properties: personId: description: Identificador da pessoa type: integer format: int64 cardNumber: description: Número do cartão type: integer format: int64 areaControl: description: Identificador da área controlada type: integer format: int64 ManufacturerUpdatedPendency: type: object allOf: – #/definitions/DevicePendency – properties: documentType: #/definitions/DocumentType document: description: Documento type: string companyName: description: Razão social type: string address: description: Endereço type: string CollectEventPendency: type: object allOf: – #/definitions/DevicePendency – properties: initialDate: description: Data inicial type: string format: date-time finalDate: description: Data final type: string format: date-time initialNSR: description: Valor inicial do NSR type: integer format: int64 finalNSR: description: Valor final do NSR type: integer format: int64 IncludePhotoPendency: type: object allOf: – #/definitions/DevicePendency – properties: personId: description: Identificador da pessoa type: integer format: int64 personName: description: Nome da pessoa type: string photoUrl: description: URL da foto type: string cardList: type: array items: #/definitions/CardInformation ExcludePhotoPendency: type: object allOf: – #/definitions/DevicePendency – properties: personId: description: Identificador da pessoa type: integer format: int64 AllPendency: type: object properties: deviceStatus: description: Requisição de status do dispositivo type: array items: #/definitions/DevicePendency deviceDateTime: description: Indica que deve ser atualizada a data/hora do dispositivo type: array items: #/definitions/DevicePendency resetDevice: description: Dados armazenados no dispositivo devem ser resetados type: array items: #/definitions/DevicePendency blockDevice: description: Dispositivo deve ser bloqueado type: array items: #/definitions/BlockDevicePendency unblockDevice: description: Dispositivo deve ser desbloqueado type: array items: #/definitions/UnblockDevicePendency setDeviceEmergency: description: Dispositivo deve entrar no modo de emergência type: array items: #/definitions/SetDeviceEmergencyPendency unsetDeviceEmergency: description: Dispositivo deve sair do modo de emergência type: array items: #/definitions/UnsetDeviceEmergencyPendency apolloIncludeCard: description: Incluir um cartão no dispositivo Apollo type: array items: #/definitions/ApolloIncludeCardPendency apolloExcludeCard: description: Excluir um cartão no dispositivo Apollo type: array items: #/definitions/ApolloExcludeCardPendency includeBiometry: description: Incluir biometria type: array items: #/definitions/IncludeBiometryPendency excludeBiometry: description: Excluir biometria type: array items: #/definitions/ExcludeBiometryPendency device: description: A configuração do dispositivo sofreu alguma alteração ou o dispositivo precisa ser configurado type: array items: #/definitions/DeviceUpdatedPendency loadHolidayList: description: Carregar a lista de feriados no dispositivo type: array items: #/definitions/LoadHolidayListPendency removeHolidayList: description: Remover a lista de feriados do dispositivo type: array items: #/definitions/DevicePendency activateDeviceOutput: description: Ativar uma saída digital do dispositivo type: array items: #/definitions/ActiveDeviceOutputPendency deactivateDeviceOutput: description: Desativar uma saída digital do dispositivo type: array items: #/definitions/DeactiveDeviceOutputPendency datamartUpdated: description: Datamart atualizado type: array items: #/definitions/DatamartUpdatedPendency personLocationUpdated: description: Atualiza o local físico da pessoa type: array items: #/definitions/PersonAreaUpdatedPendency collectEvent: description: Realizar a coleta de eventos de um dispositivo. type: array items: #/definitions/CollectEventPendency inputStatus: description: Verificar o status da uma entrada type: array items: #/definitions/DevicePendency manufacturerUpdated: description: Os dados da empresa do REP foram atualizados type: array items: #/definitions/ManufacturerUpdatedPendency updatePersonREP: description: Incluir uma pessoa no REP type: array items: #/definitions/UpdatePersonREPPendency loadAllowCardList: description: Inclusão da lista de liberação type: array items: #/definitions/DevicePendency removeAllowCardList: description: Remover a lista de liberação do dispositivo type: array items: #/definitions/DevicePendency loadBiometryList: description: Incluir uma lista de biometria no dispositivo type: array items: #/definitions/DevicePendency removeBiometryList: description: Remover da lista de biometria do dispositivo type: array items: #/definitions/DevicePendency includeCard: description: Incluir um cartão no dispositivo type: array items: #/definitions/IncludeCardPendency excludeCard: description: Remover um cartão no dispositivo type: array items: #/definitions/ExcludeCardPendency deviceDisplayMessage: description: Exibir mensagem no display do dispositivo type: array items: #/definitions/DeviceDisplayMessagePendency updateFirmware: description: Atualização do firmware do dispositivo type: array items: #/definitions/DevicePendency includePhoto: description: Incluir foto no dispositivo para reconhecimento facial type: array items: #/definitions/IncludePhotoPendency excludePhoto: description: Excluir foto do dispositivo type: array items: #/definitions/ExcludePhotoPendency Event: type: object allOf: – #/definitions/Notification – properties: eventType: type: string default: DEVICE_STARTED enum: – DEVICE_STARTED – DEVICE_ONLINE – DEVICE_OFFLINE – ISSUANCE_OF_TIME_AND_ATTENDANCE_REPORT – STARTED_USING_USB_FISCAL_PORT – PAPER_REEL_REPLACED – LACK_OF_PAPER – LOW_MEMORY – NO_MEMORY – BATTERY_REPLACED – STARTED_USING_BATTERY – STARTED_USING_ENERGY – DEVICE_LOCKED – DEVICE_UNLOCKED – TAMPER – DOOR_HELD_OPEN – DOOR_FORCED_OPEN PersonEvent: type: object properties: personId: description: Identificador de pessoa type: integer format: int64 deviceId: description: Identificador de dispositivos type: integer format: int64 date: description: Data da notificação em UTC type: string format: date-time timezoneOffset: description: Offset em minutos type: integer normalTemperature: description: Informa se a temperatura da pessoa está normal type: boolean temperature: description: Informa o valor da temperatura type: number format: float withMask: description: Informa se a pessoa está com máscara type: boolean accessAllowed: description: Informa se o acesso foi permitido type: boolean Resource: type: object allOf: – #/definitions/Notification – properties: resourceType: type: string description: Tipo de recurso default: MEMORY enum: – MEMORY – BATTERY – PAPER resourcePercent: description: Percentual de uso do recurso type: integer PersonCredentialFormat: type: string enum: – CARD – PERSON_ID VehicleCredentialFormat: type: string enum: – CARD – LICENSE_PLATE AccessNotification: type: object allOf: – #/definitions/Notification – properties: accessType: #/definitions/AccessType accessDirection: #/definitions/AccessDirection Access: type: object allOf: – #/definitions/AccessNotification – properties: cardId: description: Número do cartão type: integer format: int64 personId: description: Identificador da pessoa type: integer format: int64 creditRange: type: integer VehicleAccess: description: Veículo de Acesso type: object allOf: – #/definitions/AccessNotification – properties: vehicleCredentialFormat: #/definitions/VehicleCredentialFormat licensePlate: description: Placa do veículo type: string vehicleCardId: description: Identificador físico do crachá do veículo type: integer format: int64 PersonCredentialFormat: #/definitions/PersonCredentialFormat personCardId: description: Identificador do crachá de pessoa type: integer format: int64 personId: description: Identificador de pessoa type: integer format: int64 QRCodeAccessNotification: type: object allOf: – #/definitions/AccessNotification – properties: qrcode: type: string BluetoothAccessNotification: type: object allOf: – #/definitions/AccessNotification – properties: credentialId: description: Identificador da credencial type: integer format: int64 AccessDirection: type: string enum: – UNKNOWN – ENTRANCE – EXIT ClockIn: type: object allOf: – #/definitions/Notification – properties: nsr: description: Número sequencial de registro type: integer format: int64 pis: description: PIS da pessoa type: integer format: int64 ErrorResponse: type: object properties: code: type: integer message: type: string AccessType: description: Tipo de acesso type: string enum: – ACCESS_VALID – ACCESS_DENIED_PERMISSION – ACCESS_DENIED_SITUATION – ACCESS_DENIED_CARD_VALIDITY – ACCESS_DENIED_LEVEL_CONTROLER – ACCESS_DENIED_CREDIT_ACCESS – ACCESS_DENIED_ROLE_RANGE – ACCESS_DENIED_LOCAL_RANGE – ACCESS_DENIED_CARD_NOT_FOUND – ACCESS_VALID_ACCOMPANY – ACCESS_DENIED_ACCOMPANY – ACCESS_DENIED_INVALID_AUTHORIZER – ACCESS_DENIED_WAITING_FOR_NEXT_VALIDATION – ACCESS_DENIED_ANTI_PASSBACK – ACCESS_DENIED_CREDIT_RANGE – ACCESS_DENIED_STOCKING_CONTROL – ACCESS_DENIED_NOT_PARKING_SPACE_TYPE – ACCESS_DENIED_NOT_PARKING_SPACE – ACCESS_COERCION – ACCESS_DENIED_BIOMETRY – ACCESS_DENIED_CARD_FORMAT_ERROR – ACCESS_DENIED_FACILITY_CODE – ACCESS_DENIED_PASSWORD – ACCESS_DENIED_SECOND_CARD_NOT_PRESENTED – ACCESS_DESISTENCE – ACCESS_VALID_AUTHORIZER – ACCESS_VALID_FACILITY_CODE – ACCESS_VALID_FRAUD – ACCESS_VALID_OUT_REPOSE – ACCESS_DENIED – ACCESS_DENIED_CREDENTIAL_NOT_FOUND – ACCESS_DENIED_CREDENTIAL_VALIDITY – ACCESS_DENIED_INVALID_VEHICLE_CREDENTIAL_FORMAT – ACCESS_DENIED_INVALID_VEHICLE_CARD_CREDENTIAL – ACCESS_DENIED_WAITING_VEHICLE – ACCESS_DENIED_READER_NOT_VALIDATE_VEHICLE – ACCESS_DENIED_PERSON_NOT_ASSOCIATED_WITH_VEHICLE – ACCESS_DENIED_CUSTOM_VALIDATION – ACCESS_DENIED_BLOCK_PROVISORY_ON_EXIT – ACCESS_DENIED_CONTROLS_IN_BETWEEN_WORKDAYS – ACCESS_DENIED_WITHOUT_MASK – ACCESS_DENIED_ABNORMAL_TEMPERATURE BiometricValidation: type: string description: Tipo validação biométrica enum: – NONE – ONE_TO_ONE – BOTH ReaderDirection: type: string description: Direção de acesso enum: – ENTRANCE – EXIT – BOTH ReaderTechnology: type: string description: Tecnologia da leitora default: UNKNOWN enum: – UNKNOWN – BARCODE_CARD – RFID_CARD – SMART_CARD – BIOMETRY – QRCODE – KEYBOARD CardTechnology: description: Tecnologia do cartão type: string default: BARCODE_CARD enum: – BARCODE_CARD – RFID_CARD – SMART_CARD – QRCODE DatamartObjectType: type: string default: HOLIDAY enum: – HOLIDAY – TIMEZONE – ACCESS_LEVEL – AREA_CONTROLLED – CARD_FORMAT CommunicationMode: type: string description: Modo de comunicação default: FULL_DUPLEX enum: – FULL_DUPLEX – HALF_DUPLEX DeviceType: description: Tipo do dispositivo type: string default: AAN_32 enum: – AAN_32 – AAN_100 – AIO_168 – AIM_2SL – AIM_4SL – AP_610 – AP_620 – AP_625 – AP_500 – AP_510 – AP_520 – AIM_1SL – AIM_4 – AMS_130 – AMS_102 HolidayList: type: object properties: id: type: integer format: int64 holiday: type: array items: type: string Timezone: type: object properties: start: type: string end: type: string monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean sunday: type: boolean holiday: type: boolean TimezoneList: type: object properties: id: type: integer format: int64 timezone: type: array items: #/definitions/Timezone AreaControlList: type: object properties: id: type: integer format: int64 gmt: description: Informa a diferença em minutos do meridiano de Greenwich type: integer useDaylightSaving: description: Informa se utiliza horário de verão type: boolean startDaylightSaving: description: Informa a data início do horário de verão. (ISO 8601) type: string endDaylightSaving: description: Informa data de término do horário de verão. (ISO 8601) type: string daylightSavingOffset: description: Quantidade em minutos que será somado ao gmt em horário de verão type: integer checkLevel: description: Informa se o local controla nível da pessoa type: boolean checkAntiPassback: description: Informa se o local utiliza controle de anti-dupla, impedindo que o mesmo cartão realize acesso duas vezes seguidas na mesma direção type: boolean checkCapacity: description: Informa se o local controla lotação type: boolean checkAccessCredit: description: Informa se o local valida se o papel terá controle de acesso por meio de créditos type: boolean checkAccessLevel: description: Informa se os dispositivos que pertencem a esse local físico realizam a validação de nível da pessoa type: boolean checkTimezoneLocation: description: Informa se o local controla faixa horária do local type: boolean checkAccessLevelAuthorizer: description: Informa se o autorizador do local terá impacto nos níveis do local type: boolean checkLocationAuthorizer: description: Informa se o local valida por autorizador type: boolean antiPassbackTime: description: É o tempo mínimo de acesso para o mesmo destino, a fim de evitar duas pessoas utilizar o mesmo cartão para acessar o mesmo local type: integer format: int64 AccessLevelList: type: object properties: id: type: integer format: int64 readerAndTimezoneList: type: array items: #/definitions/ReaderAndTimezone CardFormatList: type: object properties: id: type: integer format: int64 numOfBitsOnCard: description: Informa a quantidade de bits do cartão, que pode variar segundo o seu fabricante e modelo type: integer numOfBitsFromStartForEvenParity: description: Informa a quantidade de bits de paridade par que será considerada a partir do início dos bits type: integer numOfBitsToEndForOddParity: description: Informa a quantidade de bits de paridade ímpar que será considerada a partir do final dos bits type: integer numOfBitsIFacilityCode: description: informa a quantidade de bits do código de acesso, que pode variar segundo o fabricante e modelo do cartão type: integer indexFromFirstBitToFirstFacilityCodeBit: description: Informa o bit de início do código de acesso type: integer numOfBitsInCardNumber: description: Informa a quantidade de bits do número de cartão, lembrando que a contagem inicia a partir do bit de início do número de cartão type: integer indexFromFirstBitToFirstCardNumberBit: description: Informa o bit de início do número de cartão que indica a posição de início da leitura do número do cartão type: integer facilityCode: description: Informa o código de acesso do formato type: integer format: int64 cardNumberOffset: description: Informa a quantidade de deslocamento dos bits a serem deslocados no momento da validação de dados type: integer format: int64 DocumentType: description: Tipo de documento type: string enum: – CNPJ – CEI – CPF ReaderMode: type: string description: Tipo validação default: LOCKED enum: – LOCKED – CARD_ONLY – PIN_OR_CARD – CARD_AND_PIN – UNLOCKED – FACILITY_CODE_ONLY – CIPHER_LOCK_EMULATION InputOutputState: type: string default: ACTIVE enum: – INACTIVE – ACTIVE ReaderAndTimezone: type: object properties: readerId: description: Identificador da leitora type: integer format: int64 timezoneId: description: Identificador do fuso horário type: integer format: int64 Masking: type: object properties: startTime: type: string finishTime: type: string normalDay: type: boolean saturday: type: boolean sunday: type: boolean holiday: type: boolean LprValidationResponse: type: object properties: accessType: #/definitions/AccessType ValidationResponse: type: object properties: accessType: #/definitions/AccessType verifyBiometry: description: Informa se verifica biometria type: boolean currentOwnerLocation: description: Identificador da localização atual da pessoa type: integer format: int64 personCheckLevel: description: Informa se a pessoa controla nível type: boolean PersonValidationResponse: type: object allOf: – #/definitions/ValidationResponse – properties: personId: description: Identificador da pessoa type: integer format: int64 AccessRequest: type: object properties: readerId: description: Identificador da leitora type: integer format: int64 cardId: description: Identificador do cartão type: integer format: int64 personId: description: Identificador da pessoa type: integer format: int64 requestDateTime: description: Data e hora da requisição de acesso type: string format: date-time LprAccessRequest: type: object properties: readerId: description: Identificador da leitora type: integer format: int64 licensePlate: description: Placa do veículo type: string generateNotification: description: Gera notificação type: boolean VehicleAccessRequest: type: object properties: readerId: description: Identificador da leitora type: integer format: int64 vehicleCredentialFormat: description: Formato da credencial do veículo type: string enum: – LICENSE_PLATE – CARD vehicleCredential: description: Credencial do veículo type: string authorizerPersonCardNumber: description: Número do cartão da pessoa autorizadora type: integer format: int64 authorizerPersonId: description: Identificador da pessoa autorizadora type: integer format: int64 requestDateTime: description: Data e hora da requisição type: string format: date-time QRCodeAccessRequest: type: object properties: readerId: type: integer format: int64 qrcode: type: string requestDateTime: type: string format: date-time Alarm: type: object allOf: – #/definitions/Notification – properties: inputState: #/definitions/InputOutputState ExtensibleProperty: type: object properties: id: type: integer format: int64 key: type: string value: type: string ExtensibleConfiguration: type: object description: Propriedade extensíveis properties: id: type: integer format: int64 name: type: string extensiblePropertyList: type: array items: #/definitions/ExtensibleProperty BiometricOrigin: description: Origem de um cadastro biométrico type: string default: PERSON enum: – PERSON – CARD – PIS BiometricManufacturer: type: string description: Fabricante da biometria enum: – NONE – FINGERPRINT_SAGEM – FINGERPRINT_SUPREMA – FINGERPRINT_VIRDI – FINGERPRINT_NITGEN – FINGERPRINT_CAMA – FINGERPRINT_INNOVATRICS – HANDKEY_IR – FACIAL UpdatePersonREPPendency: type: object allOf: – #/definitions/DevicePendency – properties: operationId: description: Tipo da operação type: string enum: – INCLUDE_CARD – EXCLUDE_CARD – EXCLUDE_PERSON cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology personId: description: Identificador da pessoa type: integer format: int64 personName: description: Nome da pessoa type: string pis: description: PIS type: integer format: int64 biometricStatus: description: Status da biometria type: string enum: – NOT_CHANGE – CHANGE – EXCLUDE verifyBiometrics: description: Validação da biometria type: string enum: – NOT_VALID_BIOMETRY – VALID_CARD_AND_BIOMETRY – ONLY_VALID_BIOMETRY biometry: type: array items: #/definitions/Biometry Biometry: type: object properties: manufacturer: #/definitions/BiometricManufacturer biometrySecurityLevel: description: Nível de segurança biométrica type: integer templateList: type: array description: Caracteres codificados em base64 items: type: string AccessBiometry: allOf: – #/definitions/Biometry – properties: personId: description: Identificador da pessoa type: integer format: int64 cardList: description: Lista de cartões type: array items: #/definitions/CardAndTechnology IncludeBiometry: type: object properties: origin: #/definitions/BiometricOrigin originId: description: Identificador da origem do cadastro biométrico type: integer format: int64 manufacturer: #/definitions/BiometricManufacturer templateList: type: array description: Codificado em base64 items: type: string BiometricTechnologyTemplatesList: type: object properties: manufacturer: #/definitions/BiometricManufacturer biometrySecurityLevel: description: Nível de segurança biométrica type: integer templates: type: array description: Codificado em base64 items: type: string CardAndTechnology: type: object properties: cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology CardInformation: type: object description: Informação do cartão properties: cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology startDate: description: Data inicial type: string expirationDate: description: Data de expiração type: string HealthcheckStatus: type: string enum: – UP – DOWN HealthcheckItemResponse: type: object properties: name: type: string status: #/definitions/HealthcheckStatus HealthcheckResponse: type: object properties: status: #/definitions/HealthcheckStatus checks: type: array items: #/definitions/HealthcheckItemResponse PersonTemplates: type: object properties: personId: description: Identificador da pessoa type: integer format: int64 cardList: description: Lista de cartões type: array items: #/definitions/CardAndTechnology technologies: type: array items: #/definitions/BiometricTechnologyTemplatesList PersonPhoto: type: object properties: personId: description: Identificador da pessoa type: integer format: int64 personName: description: Nome da pessoa type: string photoUrl: description: Url da foto type: string card: #/definitions/CardInformation PersonInfo: type: object properties: personId: description: Identificador da pessoa type: integer format: int64 personName: description: Nome da pessoa type: string photoUrl: description: Url da foto type: string cards: description: Informação do cartão type: array items: #/definitions/CardInformation DriverManufacturer: type: object properties: manufacturerName: description: Nome do fabricante do driver atualizado type: string PersonPhotoTemplates: type: object properties: personId: description: Identificador da pessoa type: integer format: int64 name: description: Nome type: string photoURL: description: Url da foto type: string cardList: description: Lista de cartões type: array items: #/definitions/CardInformationtags: – name: Datamart description: Informações gerais para o controle de acesso – name: Device description: Assuntos relacionados a dispositivos – name: Driver description: Informações gerais do driver – name: Healthcheck description: Status da requisição de acesso e notificação – name: Server description: Status do servidor – name: LPR description: Requisição de acesso por placa de veículo – name: Notification description: Serviços de notificação – name: Pendency description: Assuntos relacionados a pendências