Ronda senior X SDK API (Ronda Senior X SDK)

Ronda senior X SDK API (Ronda Senior X SDK)

128 views 02/08/2021 02/08/2021 integrador 1

2.0info: 1.0.0 workflow_request_moderator description: Serviço para moderação das requisições BPM x-senior-domain: bpo x-senior-domain-path: bpo x-senior-service-path: workflow_request_moderator contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /bpo/workflow_request_moderator/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /queries/healthcheck: post: description: Query for health check – SRE x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/upDown checks: #/definitions/checkData default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN checkData: type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: #/definitions/upDown genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE
2.0info: 1.0.0 Ronda senior X SDK APIhost: sam-api.senior.com.br /sdk/v1schemes: – http – httpspaths: /device/biometry: post: summary: Cadastro de biometria tags: – Device – application/json parameters: – 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: Retorna listas de biometrias tags: – Datamart – application/json parameters: – 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: Id 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: Retorna uma listagem de formatos de cartão tags: – Datamart – application/json parameters: – 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: Retorna uma lista de locais e suas configurações tags: – Datamart – application/json parameters: – 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: Retorna uma lista de níveis de acesso tags: – Datamart – application/json parameters: – 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: description: Retorna listas de feriados. summary: Retorna listas de feriados tags: – Datamart – application/json parameters: – 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: Retorna uma lista de faixa horária tags: – Datamart – application/json parameters: – 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 /driver: get: description: Retorna o driver associado ao driverKey e suas propridades. summary: Retorna driver associado ao driverKey tags: – Driver – application/json parameters: – 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 propridades. 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: description: Retorna data e horário (ISO 8601) summary: Retorna data e horário tags: – Driver – application/json parameters: – 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 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: description: Informa para o sistema, o nome do fabricante do driver que está usando essa chave. summary: Informa para o sistema, o nome do fabricante do driver que está usando essa chave. tags: – Driver – application/json parameters: – 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: – 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 /device/accessrequest: post: description: A requisição de acesso de pessoa podera 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: – 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: Retorna status da requisição de acesso tags: – Healthcheck – application/json parameters: – 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 dentificador 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: – 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 /device/{id}/card: get: summary: Lista de crachás description: Lista de crachás com acesso liberado no dispositivo. tags: – Device – application/json parameters: – 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 crachás schema: type: array items: #/definitions/Card 401: description: O driver_key ou partner_key são inválidos 404: description: Device not found 500: description: Erro de servidor schema: #/definitions/ErrorResponse /server/status: get: description: Informa o status do servidor summary: Informa o status do servidor tags: – Server – application/json parameters: – 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: DriverStatusInput: type: object properties: driverIds: type: array items: type: integer format: int64 CredentialOwnerType: type: string enum: – PERSON – VEHICLE Card: type: object properties: cardNumber: description: Número físico do crachá 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: Área Id 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 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 DriverDateTime: type: object properties: dateTime: type: string ErrorResponse: type: object properties: code: type: integer message: type: string AccessType: description: Tipos 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 CardTechnology: description: Tecnologia do cartão type: string default: BARCODE_CARD enum: – BARCODE_CARD – RFID_CARD – SMART_CARD – QRCODE 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 horario 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 crachá 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 tera 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 crachá 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 ReaderAndTimezone: type: object properties: readerId: type: integer format: int64 timezoneId: type: integer format: int64 ValidationResponse: type: object properties: accessType: description: Tipo de acesso #/definitions/AccessType verifyBiometry: description: Informa se verifica biometria type: boolean currentOwnerLocation: description: Id 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: Id da pessoa type: integer format: int64 AccessRequest: type: object properties: readerId: description: Id da leitora type: integer format: int64 cardId: description: Id do cartão type: integer format: int64 personId: description: Id da pessoa type: integer format: int64 requestDateTime: description: Data e hora da requisição de acesso type: string format: date-time VehicleAccessRequest: type: object properties: readerId: description: Id 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: Id da pessoa autorizadora type: integer format: int64 requestDateTime: description: Data e hora da requisição type: string format: date-time ExtensibleProperty: type: object properties: id: type: integer format: int64 key: type: string value: type: string ExtensibleConfiguration: type: object 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 IncludeBiometry: type: object properties: origin: description: Origem de um cadastro biométrico #/definitions/BiometricOrigin originId: description: Id da origem do cadastro biométrico type: integer format: int64 manufacturer: description: Fabricante da biometria #/definitions/BiometricManufacturer templateList: type: array description: Codificado em base 64 items: type: string BiometricTechnologyTemplatesList: type: object properties: manufacturer: #/definitions/BiometricManufacturer biometrySecurityLevel: type: integer templates: type: array description: base64 encoded characters items: type: string CardAndTechnology: type: object properties: cardNumber: description: Número do cartão type: integer format: int64 cardTechnology: #/definitions/CardTechnology 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: Id da pessoa type: integer format: int64 cardList: description: Lista de cartões type: array items: #/definitions/CardAndTechnology technologies: type: array items: #/definitions/BiometricTechnologyTemplatesList DriverManufacturer: type: object properties: manufacturerName: description: Nome do fabricante do driver atualizado type: stringtags: – name: Datamart description: Informações gerais para o controle de acesso – name: Device description: Serviços relacionado 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

Este artigo foi útil para você?

Leave A Comment