2.0info: 1.4.0 document_signer description: document-signer x-senior-domain: edocsx_common x-senior-domain-path: edocsx_common x-senior-service-path: document_signer contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/edocsx_commonsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /document_signer/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document_signer/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document_signer/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /document_signer/signals/signNfeAbi: post: description: Assina digitalmente o XML de uma NFeABI tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml – correlationId – callbackPrimitive properties: branchId: type: string description: ID da filial para buscar o certificado digital xml: type: string description: XML da NFeABI a ser assinado correlationId: type: string description: ID de correlação para rastreabilidade techResponsible: type: object allOf: – #/definitions/techResponsible description: Responsável técnico callbackPrimitive: type: string description: Primitiva de callback para resposta assíncrona callbackDomain: type: string description: Domínio de callback (opcional – se não informado, usa o domínio do chamador) callbackService: type: string description: Serviço de callback (opcional – se não informado, usa o serviço do chamador) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /document_signer/signals/signNfeAbiEvent: post: description: Assina digitalmente o XML de um evento de NFeABI tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml – correlationId – callbackPrimitive properties: branchId: type: string description: ID da filial para buscar o certificado digital xml: type: string description: XML do evento de NFeABI a ser assinado correlationId: type: string description: ID de correlação para rastreabilidade callbackPrimitive: type: string description: Primitiva de callback para resposta assíncrona callbackDomain: type: string description: Domínio de callback (opcional – se não informado, usa o domínio do chamador) callbackService: type: string description: Serviço de callback (opcional – se não informado, usa o serviço do chamador) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /document_signer/signals/signNfe: post: description: Assina digitalmente o XML de uma NF-e tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml – correlationId – callbackPrimitive properties: branchId: type: string description: ID da filial para buscar o certificado digital xml: type: string description: XML do evento de NF-e a ser assinado correlationId: type: string description: ID de correlação para rastreabilidade techResponsible: type: object allOf: – #/definitions/techResponsible description: Responsável técnico callbackPrimitive: type: string description: Primitiva de callback para resposta assíncrona callbackDomain: type: string description: Domínio de callback (opcional – se não informado, usa o domínio do chamador) callbackService: type: string description: Serviço de callback (opcional – se não informado, usa o serviço do chamador) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /document_signer/signals/signNfeEvent: post: description: Assina digitalmente o XML de um evento de NF-e tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml – correlationId – callbackPrimitive properties: branchId: type: string description: ID da filial para buscar o certificado digital xml: type: string description: XML do evento de NF-e a ser assinado correlationId: type: string description: ID de correlação para rastreabilidade callbackPrimitive: type: string description: Primitiva de callback para resposta assíncrona callbackDomain: type: string description: Domínio de callback (opcional – se não informado, usa o domínio do chamador) callbackService: type: string description: Serviço de callback (opcional – se não informado, usa o serviço do chamador) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /document_signer/signals/signDere: post: description: Assina digitalmente o XML de um evento DeRE tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml – correlationId – eventCode – callbackPrimitive properties: branchId: type: string description: ID da filial para buscar o certificado digital xml: type: string description: XML do evento DeRE a ser assinado correlationId: type: string description: ID de correlação para rastreabilidade eventCode: type: string description: Código do evento DeRE que está sendo transmitido callbackPrimitive: type: string description: Primitiva de callback para resposta assíncrona callbackDomain: type: string description: Domínio de callback (opcional – se não informado, usa o domínio do chamador) callbackService: type: string description: Serviço de callback (opcional – se não informado, usa o serviço do chamador) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down statusSign: type: string enum: – SUCCESS – SIGN_ERROR description: Status da assinatura digital: * `SUCCESS` – Assinatura realizada com sucesso * `SIGN_ERROR` – Erro durante a assinatura userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text checkData: description: Dados do healthcheck type: object required: – name – checkStatus properties: name: type: string description: Nome do healthcheck checkStatus: type: string allOf: – #/definitions/upDown description: Status do healthcheck techResponsible: description: Dados do responsável técnico type: object required: – cnpj – contact – email – phone – csrtId – csrtHash properties: cnpj: type: string description: CNPJ do responsável técnico contact: type: string description: Nome do contato do responsável técnico email: type: string description: Email do responsável técnico phone: type: string description: Telefone do responsável técnico csrtId: type: string description: ID do CSRT csrtHash: type: string description: Hash do CSRT documentSignedResponse: description: Dados da resposta da tentativa de assinatura do documento type: object required: – statusSign – correlationId properties: statusSign: type: string allOf: – #/definitions/statusSign description: Status da assinatura correlationId: type: string description: ID de correlação para rastreabilidade signedXml: type: string description: XML assinado (presente apenas em caso de sucesso) errorMessage: type: string description: Mensagem de erro (presente apenas em caso de falha) digestValue: type: string description: Valor do digest da assinatura (presente apenas em caso de sucesso) notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage