Listar as TAGs do Documento (API)
Este endpoint da API D4Sign permite que você liste todas as TAGs associadas a um documento específico. É uma forma eficaz de organizar e categorizar seus documentos, facilitando a busca e a gestão.
Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/tags/{UUID-DOCUMENTO}?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Header
O cabeçalho da sua requisição deve conter o Content-Type como application/json.
{
"Content-Type": "application/json"
}
Body
Para este endpoint, o corpo da requisição não é necessário. O UUID-DOCUMENTO é enviado na URL.
Parâmetros de Requisição (URL)
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
pg |
Número | Opcional | O número da página que você deseja listar. Cada página retorna até 500 resultados. |
Resposta (Status 200 - Sucesso)
Quando a requisição for bem-sucedida, você receberá um objeto JSON contendo o UUID do documento e uma string com suas TAGs, separadas por vírgula. Note que o exemplo de resposta não inclui o bloco de paginação, mas a descrição indica que ele existe.
{
"uuid_arquivo": "uuid-do-documento",
"TAGs": "teste1, teste2, teste4"
}Detalhes dos Campos da Resposta:
| Campo | Tipo | Descrição |
uuid_arquivo |
String | O UUID (identificador único) do documento ao qual as TAGs estão associadas. |
TAGs |
String | Uma string contendo todas as TAGs do documento, separadas por vírgulas. |
🚧 Observações Importantes:
-
Paginação: A listagem das TAGs pode ser paginada, retornando até 500 resultados por página. Use o parâmetro
pgna URL para navegar entre as páginas. O primeiro bloco da resposta (se a lista for paginada e incluir informações de paginação) exibirá o total de páginas disponíveis.