Eventos Customizados

Introdução

Agora é possível que usuários da API enviem evidências de fatos ocorridos do lado client-side da aplicação. Os eventos disponíveis atualmente são:

Envio de Token de Email e SMS
Envio de Imagem coletada como evidência

🚧
Ordenação dos eventos
A ordenação dos eventos no log do documento será feita pela data de recebimento na API, ou seja, pelo parâmetro created_at dos eventos.

📘
Formato aceito
A imagem deverá ser no formato jpeg com encode em base64.

Events: atributos dos eventos customizados

Atributo	Descrição	Exemplo
`kind`	Tipo do token	token_email ou token_sms
`signer_name`	Nome completo do signatário	Marco Zumba
`signer_email`	Email do signatário	[email protected]
`signer_phone_number`	Telefone do signatário, número entre 10 e 11 dígitos	551198768933
`occurred_at`	Data e hora da coleta feita pelo Operador.	2018-06-21T16:47:32.123Z

Token Email

POST /api/v2/documents/:document_key/events?access_token={{access_token}}

{
    "event": {
          "data": {
              "kind": "token_email",
              "signer_name": "John Doe",
              "signer_email": "[email protected]",
              "occurred_at": "2020-10-28 11:00:00 +0300"
          }
    }
}

Token SMS

POST /api/v2/documents/:document_key/events?access_token={{access_token}}

{
     "event": {
          "data": {
              "kind": "token_sms",
              "signer_name": "John Doe",
              "signer_phone_number": "11666999666",
              "occurred_at": "2020-10-28 11:00:00 +0300"
          }
     }
}

Imagem

POST /api/v2/documents/:document_key/images?access_token={{access_token}}

Atributo	Descrição	Exemplo
`title`	Título da imagem. Limite de 70 caracteres	Foto Marco Zumba
`occurred_at`	Dara e Hora da coleta feita pelo Operador.	2018-06-21T16:47:32.123Z
`content_base64`	Imagem Jpeg em base64	data:image/jpeg;base64,/9j/4AAQSkZJR ...

{
     "attachment": {
         "title": "Foto Selfie de Marco Zumba",
         "occurred_at": "2020-10-28T23:59:59-03:00",
         "content_base64": "data:image/jpeg;base64,/9j/4AAQSkZJR ..."
    }
}

🚧
Os possíveis status de retorno são:
403 (Forbidden): Caso a feature_toggle "toggle_custom_events" esteja desabilitada
404 (Not Found): Quando o documento não está com status em processo
422 (Unprocessable Entity): Caso algum parâmetro obrigatório seja passado de forma incorreta ou não seja informado
201 (Created): caso os parâmetros sejam informados corretamente

Exemplo completo

Requisição

POST /api/v2/documents/:key/events?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

{
  "document": {
    "key": "28aeb572-f0d7-4904-919f-47f25a3f1e62",
    "account_key": "db97946a-22ab-467d-bbb3-162cc69d0339",
    "path": "/CNH.pdf",
    "filename": "CNH.pdf",
    "uploaded_at": "2020-11-05T10:28:31.504Z",
    "updated_at": "2020-11-05T10:28:51.675Z",
    "finished_at": null,
    "deadline_at": "2020-12-05T07:27:25.000-03:00",
    "status": "running",
    "auto_close": true,
    "locale": "pt-BR",
    "metadata": {},
    "sequence_enabled": false,
    "signable_group": 1,
    "remind_interval": 3,
    "downloads": {
      "original_file_url": "CNH.pdf"
    },
    "template": null,
    "signers": [
      {
        "list_key": "907f66c3-3066-4cc2-bf53-c2da279494a6",
        "key": "d396b15f-e689-4aea-b204-bb882c6c0d6b",
        "request_signature_key": "6c3d7a77-2f0b-4835-80bd-29605a7af9bf",
        "email": "[email protected]",
        "name": "Marco Zumba",
        "has_documentation": false,
        "documentation": null,
        "birthday": null,
        "phone_number": null,
        "sign_as": "sign",
        "delivery": "email",
        "url": "http://3.clicksign.dev:3000/sign/6c3d7a77-2f0b-4835-80bd-29605a7af9bf",
        "auths": [
          "email"
        ],
        "created_at": "2020-11-05T10:28:44.676Z"
      }
    ],
    "events": [
      {
        "name": "custom",
        "data": {
          "kind": "token_sms",
          "signer_name": "John Doe",
          "occurred_at": "2020-10-28T11:00:00-03:00",
          "signer_phone_number": "11666999666"
        },
        "occurred_at": "2020-11-05T10:30:09.368Z"
      },
      {
        "name": "custom",
        "data": {
          "kind": "token_email",
          "signer_name": "John Doe",
          "occurred_at": "2020-10-27T23:59:59-03:00",
          "signer_email": "[email protected]"
        },
        "occurred_at": "2020-11-05T10:30:02.006Z"
      },
      {
        "name": "update_deadline",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Alice Doe"
          },
          "account": {
            "key": "db97946a-22ab-467d-bbb3-162cc69d0339"
          },
          "deadline_at": "2020-12-05T07:27:25.000-03:00"
        },
        "occurred_at": "2020-11-05T10:28:51.698Z"
      },
      {
        "name": "add_signer",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Alice Doe"
          },
          "account": {
            "key": "db97946a-22ab-467d-bbb3-162cc69d0339"
          },
          "signers": [
            {
              "sign_as": "sign",
              "key": "d396b15f-e689-4aea-b204-bb882c6c0d6b",
              "email": "[email protected]",
              "name": "Marcos Zumba",
              "birthday": null,
              "documentation": null,
              "has_documentation": false,
              "created_at": "2020-11-05T07:28:44.676-03:00",
              "auths": [
                "email"
              ],
              "selfie_enabled": false,
              "list_key": "907f66c3-3066-4cc2-bf53-c2da279494a6",
              "url": "http://3.clicksign.dev:3000/sign/d396b15f-e689-4aea-b204-bb882c6c0d6b"
            }
          ]
        },
        "occurred_at": "2020-11-05T10:28:47.118Z"
      },
      {
        "name": "upload",
        "data": {
          "user": {
            "email": "[email protected]",
            "name": "Alice Doe"
          },
          "account": {
            "key": "db97946a-22ab-467d-bbb3-162cc69d0339"
          },
          "deadline_at": "2020-12-05T07:27:25.343-03:00",
          "auto_close": true,
          "locale": "pt-BR"
        },
        "occurred_at": "2020-11-05T10:28:31.536Z"
      }
    ],
    "attachments": []
  }
}