Observadores
Observadores acompanham o documento sem assinar. Eles são cadastrados na seção Observadores da tela Detalhe do documento.
Conforme a opção system_notification:
- Ligada (true): o observador não entra no envio ao provedor e não recebe avisos a cada etapa. Quando o documento fica totalmente assinado, ele recebe por e-mail uma cópia do documento final, com o PDF anexado.
- Desligada (false): o observador é incluído no envio ao provedor.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /digital-signature/documents/{document_uuid}/observers | Lista os observadores do documento |
| POST | /digital-signature/documents/{document_uuid}/observers | Cadastra um observador |
| GET | /digital-signature/documents/{document_uuid}/observers/{id} | Consulta um observador |
| PUT | /digital-signature/documents/{document_uuid}/observers/{id} | Altera um observador |
| DELETE | /digital-signature/documents/{document_uuid}/observers/{id} | Remove um observador |
GET /digital-signature/documents/{document_uuid}/observers
Lista os observadores do documento.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| per_page | Não | Quantidade de registros por página. Sem ele, a resposta é a lista simples |
| page | Não | Número da página, quando per_page é informado |
Resposta (200): lista de observadores.
POST /digital-signature/documents/{document_uuid}/observers
Cadastra um observador no documento.
Corpo (JSON)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | Texto | Nome do observador |
| Sim | Texto | E-mail do observador | |
| cellphone | Não | Texto | Celular do observador |
| system_notification | Não | Booleano | Define como o observador é avisado. Veja a descrição no início da página |
Resposta (201): o observador cadastrado.
GET, PUT e DELETE /digital-signature/documents/{document_uuid}/observers/{id}
- GET: devolve o observador (200).
- PUT: altera o observador. Envie apenas os campos que mudam, entre
name,email,cellphoneesystem_notification. Resposta 200 com o observador alterado. - DELETE: remove o observador. Resposta 200.