Endpoints Observadores
Endpoint de Observadores
Importante
Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
Ex.: <https://secure.d4sign.com.br/api/v1/safes?tokenAPI=`{SEU-TOKEN}`&cryptKey=`{SEU-CRYPT-KEY}`>
Listar observadores do documento
GET
/watcher/{UUID-DOCUMENTO}
GET
/watcher/{UUID-DOCUMENTO}
Este método listará todos os observadores do documento
{
"Content-Type": "application/json"
}
{
"uuid_arquivo": "uuid-do-documento",
"watchers" : [
{
"email": "[email protected]",
"perfil": "0"
}
]
}
Adicionar observador no documento
POST
/watcher/{UUID-DOCUMENTO}
/add
POST
/watcher/{UUID-DOCUMENTO}
/addEste método irá adicionar um observador em seu documento
{
"Content-Type": "application/json"
}
{
"email":"[email protected]",
"permission":"0"
}
{
"message": "Email added sucessfully",
"uuid": "uuid-documento",
"watcher": "[email protected]"
}
Parâmetro | Descrição |
---|---|
email (obrigatório) | Email do observador |
permission (opcional) | 0 para perfil básico (pode fazer download) |
1 para perfil de visualização (não pode fazer download) |
Remover observador do documento
POST
/watcher/{UUID-DOCUMENTO}
/remove
POST
/watcher/{UUID-DOCUMENTO}
/removeEste método irá remover um observador do seu documento
{
"Content-Type": "application/json"
}
{
"email":"[email protected]"
}
{
"message": "Email removed sucessfully",
"watcher": "[email protected]"
}
Parâmetro | Descrição |
---|---|
email (obrigatório) | Email do observador |
Remover TODOS os observadores do documento
POST
/watcher/{UUID-DOCUMENTO}
/erase
POST
/watcher/{UUID-DOCUMENTO}
/eraseEste método irá remover TODOS os observadores do seu documento
{
"Content-Type": "application/json"
}
{
"message": "All watcher removed sucessfully"
}
Updated 19 days ago