Ir para o conteúdo principal

[Assine Aqui] Manual Documental da API do Assine Aqui

Objetivo

O objetivo deste estudo é documentar as rotas da API do Sistema Gov.Doc. 

Introdução

estarotaservepara
Rota ​/api​/Assinaturas
Descrição
Parâmetros
o usuário assinar um documento de maneira simples.
Request Body 
  "cpf": "string" cpf do usuário logado.
  "senha": "string" senha do usuário logado.
  "sistemaClientId": Guid - o Id do sistema que está assinando.
  "documentosIds": ["string"] - aceita uma lista de documentos para assinar.
Response 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cpf": "string",
  "sistemaClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentoId": "string",
  "cargo": "string",
  "matricula": "string",
  "nome": "string",
  "data": "2022-08-26T05:30:59.797Z",
  "dataDeRevogacao": "2022-08-26T05:30:59.797Z",
  "corpo": "string",
  "revogada": true,
  "ehUsuarioExterno": true
}
arotaparaassinar
Rota /api/Assinaturas/AssinarComToken
Descrição
Parâmetros
com token utiliza como forma de autenticação para o documento a partir de um token que será enviado para o e-mail.
Request Body  
  •  "cpf": "string"- cpf do usuário logado
  •   "token": "string" - o token que será enviado para o e-mail do usuário logado. 
  •  "sistemaClientId": Guid - Id do sistema que    está assinando.
  •   "documentosIds": ["string"] - aceita uma lista de documentos(lista de Id)
  •   "documentosCorposEmHash": ["string"] é o Hash que será criado no corpo do documento, quando documento for alterado o Hash também deverá ser alterado.
Response 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cpf": "string",
  "sistemaClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentoId": "string",
  "cargo": "string",
  "matricula": "string",
  "nome": "string",
  "data": "2022-08-26T05:38:17.776Z",
  "dataDeRevogacao": "2022-08-26T05:38:17.776Z",
  "corpo": "string",
  "revogada": true,
  "ehUsuarioExterno": true
}
Rota /api/Assinaturas/Revogar
Descrição
Parâmetros
Request Body 
{
  "cpf": "string" - cpf do usuário logado
  "senha": "string" - senha do usuário
  "assinaturaId": Guid - Id da assinatura que irá revogar
}
Response 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cpf": "string",
  "sistemaClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentoId": "string",
  "cargo": "string",
  "matricula": "string",
  "nome": "string",
  "data": "2022-08-26T05:46:48.885Z",
  "dataDeRevogacao": "2022-08-26T05:46:48.885Z",
  "corpo": "string",
  "revogada": true,
  "ehUsuarioExterno": true
}
Rota /api/Assinaturas/GerarToken
Descrição
Parâmetros
Request Body 
{
  "cpf": "string" - cpf do usuário logado
  "senha": "string" - senha do usuário.
  "sistemaClientId": Guid - Id do sistema
}
Response
retornar um código para o e-mail do usuário logado.
Rota /api/Assinaturas/RevogarPorDocumentoId
Descrição
Parâmetros
Request Body 
{
  "cpf": "string" - cpf do usuário logado
  "senha": "string" - senha do usuário
  "documentoId": "string" - Id da assinatura que irá revogar
  "sistemaClientId": Guid  - Id do sistema
}
Response 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cpf": "string",
  "sistemaClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentoId": "string",
  "cargo": "string",
  "matricula": "string",
  "nome": "string",
  "data": "2022-08-26T05:55:43.261Z",
  "dataDeRevogacao": "2022-08-26T05:55:43.261Z",
  "corpo": "string",
  "revogada": true,
  "ehUsuarioExterno": true
}
Rota /api/Assinaturas/{id}
Descrição
Parâmetros
Request Body 
{
  "id": Guid, Id do documento
}
Response
Rota ​/api​/Assinaturas​/BuscarPorCPF
Descrição
Parâmetros
Request Body
Response
Rota /api/Assinaturas/BuscarPorDocumentoId
Descrição
Parâmetros
Request Body
Response
Rota /api/Assinaturas/BuscarAssinaturasValidasDoDocumento
Descrição
Parâmetros
Request Body
Response
Rota /api/Assinaturas/ValidarAssinatura
Descrição
Parâmetros
Request Body
Response
Voltar ao topo