Listar Todos os Documentos (API)
Esta seção da API D4Sign permite que você obtenha uma lista completa de todos os documentos da sua conta, facilitando o gerenciamento e o acompanhamento do status de cada um.
🚧 Importante: Não esqueça de enviar o tokenAPI
e cryptKey
em sua requisição. Exemplo: https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Este endpoint retorna todos os documentos da sua conta.
GET /documents
Parâmetros de Requisição (URL)
Parâmetro |
Descrição |
|
Parâmetro de paginação. Utilize para navegar entre as páginas de resultados. |
📘 Paginação: O resultado será de 500 documentos por página. Utilize o parâmetro
pg
na URL para paginar o resultado. Exemplo:https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={CRYPT-KEY}&pg=2
O primeiro bloco do resultado exibirá o total de páginas disponíveis.
Header
JSON
{
"Content-Type": "application/json"
}
Resposta
A resposta será um array de objetos, onde cada objeto representa um documento e contém suas principais informações:
JSON
[
{
"uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
"nameDoc": "teste.pdf",
"type": "application/pdf",
"size": "118990",
"pages": "6",
"uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
"safeName": "Atendimento",
"statusId": "3",
"statusName": "Aguardando Assinaturas",
"statusComment": "Comentário sobre cancelamento",
"whoCanceled": "E-mail de quem cancelou o documento"
},
{
// ... Outros documentos
}
]