Histórico de atividades do documento

O intuito principal desse endpoint é possibilitar a recuperação do histórico de atividades para um documento especifico. A rota ainda provê a possibilidade de retorno no formato padrão JSON, ou em formato de arquivo PDF para download.

Coletar Histórico de atividades

GET https://api.zapsign.com.br/api/v1/docs/signer-log/{{doc_token}}?download_pdf=boolean

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Path Parameters

Name	Type	Description
doc_token	string	O token do documento que se deseja analisar o histórico de atividades

Query Parameters

Name	Type	Description
download_pdf	boolean	Valor que permite decidir o tipo de retorno que o endpoint irá devolver. Ex.: download_pdf=true ou download_pdf=false Caso seja o valor atribuído seja true O retorno será um arquivo PDF com o histórico de atividades nele. Caso seja false ou caso não esteja preenchido, será retornado, em formato JSON, um lista com os valores de cada atividade feita no documento pelo signatário.

Exemplos de retorno de sucesso:

Status 200 - Formato JSON

[
    {
        "time": "2024-11-27 17:44:32.117577+00:00",
        "user": "[e-mail]",
        "event": "Documento visualizado",
        "description": "Documento visualizado por [e-mail]"
    },
    {
        "time": "2024-11-27 17:44:34.395952+00:00",
        "user": "[e-mail]",
        "event": "Confirmação de leitura",
        "description": "Confirmação de leitura de [e-mail]"
    },
    {
        "time": "2024-11-27 17:45:29.398835+00:00",
        "user": "[e-mail]",
        "event": "Validação reconhecimento facial",
        "description": "Validação do rosto de [e-mail] com a foto do documento de identidade (anexo no relatório de assinaturas)"
    },
    {
        "time": "2024-11-27 17:45:40.904009+00:00",
        "user": "[e-mail]",
        "event": "Aceitação do processamento de dados pessoais",
        "description": "[e-mail] concordou com o processamento de dados pessoais de acordo com a Política de Privacidade"
    },
    {
        "time": "2024-11-21 05:18:45.733798+00:00",
        "user": "[e-mail]",
        "event": "Documento criado",
        "description": "O documento foi criado por [e-mail] via web"
    }
]

Status 200 - Arquivo em pdf

Neste modelo o endpoint retorna um arquivo de download direto, no seguinte modelo:

Exemplos de retorno de erro:

Status 401 - Não Autorizado

Para este erro o endpoint retorna no atributo StatusCode o valor 401, indicando que o token enviado não tem permissão de visualizar os dados desse documento.

Para esse erro sugerimos que verifique se o token enviado nos Headers está correto de acordo como exemplo já descrito acima.

Status 404 - Não encontrado

Neste erro o endpoint retorna o StatusCode com valor 404, indicando que o doc token enviado não foi encontrado.

Quando esse erro acontece, sugerimos conferir se o token enviado na url do endpoint foi o token correto.