Endpoints Cofres

Suggest Edits

Endpoints Cofres

🚧

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 todos os cofres

GET /safes

Testar endpoint 🧪

Este objeto retornará TODOS os COFRES da sua conta. 

{
    "Content-Type": "application/json"
}

{
    "uuid-safe": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "name-safe": "Contratos"
},
{...}

Listar todos os documentos de um cofre ou pasta

GET /documents/{UUID-SAFE}/safe

Testar endpoint 🧪

Esse objeto retornará todos os documentos que estiverem associados ao cofre e pasta informada.

Para filtrar com a pasta, utilize /documents/{UUID-SAFE}/safe/{UUID-FOLDER}

📘

O resultado será de 500 documentos por páginas
Utilize o parametro PG na URL para paginar o resultado. Ex.:
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

{
    "Content-Type": "application/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"
}

Parâmetros de requisição

ParâmetroDescrição
UUID-SAFE (obrigatório)UUID do COFRE que deverá ser listado.
UUID-FOLDERUUID da PASTA (opcional)

Listar pastas do cofre

GET /folders/{UUID-SAFE}/find

Testar endpoint 🧪

Este objeto retornará TODAS as PASTAS do cofre.

{
    "Content-Type": "application/json"
}

[{
    "uuid_safe": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "uuid_folder": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "name": "Contratos",
    "dt_cadastro": "2017-08-21 21:43:42"
},
{...}]

Parâmetros de requisição

ParâmetroDescrição
UUID-SAFE (obrigatório)UUID do COFRE que deverá ser listado.

Criar pasta no cofre

POST/folders/{UUID-SAFE}/create

Testar endpoint 🧪

Esse objeto irá criar uma pasta dentro do cofre informado.

{
    "Content-Type": "application/json"
}


{
    "folder_name": "Nome da pasta"
}

{
    "message": "Folder created",
    "uuid": "{UUID-FOLDER}"
}
ParâmetroDescrição
folder_name (obrigatório)Nome da pasta

Renomear pasta do cofre

POST/folders/{UUID-SAFE}/rename

Testar endpoint 🧪

Esse objeto irá renomear uma pasta dentro do cofre informado.

{
    "Content-Type": "application/json"
}

{
    "folder_name": "Nome da pasta",
    "uuid_folder": "{UUID-FOLDER}"
}

{
    "message": "Folder changed"
}
ParâmetroDescrição
folder_name (obrigatório)Nome da pasta
uuid_folder (obrigatório)UUID da pasta que será renomeada

Criar lote

POST/batches

Testar endpoint 🧪

Este método criará um lote de documentos

{
    "Content-Type": "application/json"
}

{
    "keys": [
    	"0b2ec469-6b49-42bb-809f-d977279baeeb",
    	"db75a09b-6b30-48b9-b9f0-873351a050ed",
    	"42334730-5a93-48ae-b5e4-e8e82d62610a"
    	]
    
}

{
    "message": "Batches created",
    "uuid_batches": "lote_embed_232342asd-ss134asd-xASdwe",
    "total": "25"
}
ParâmetroDescrição
keys(obrigatório)UUID dos documentos que farão parte do lote. Atenção: O máximo são 25 documentos por lote.

Exibir saldo da conta

GET/account/balance

Testar endpoint 🧪

Este objeto retornará o balanço da sua conta

{
    "Content-Type": "application/json"
}


{
    "credit": "999",
    "sent": "372",
    "used_balance": "372/999"
}

Updated about 2 years ago