O passo a passo de importar é o mesmo para a API v3, o ClickFlow, o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação. O que muda é o arquivo, o host e, no Aceite, a credencial. Os downloads estão em Collections, nesta ordem: API v3, ClickFlow (Orquestrador e Executor), Módulo de Coleta de Dados (ClickForm) e Módulos de Aceite e de Notificação.

Como importar

1. Baixe a collection e, no Postman e no Insomnia, o environment do produto em Collections.
2. Importe os dois arquivos.
3. Selecione o environment de sandbox.
4. Na API v3, no ClickFlow e no Módulo de Coleta de Dados (ClickForm), preencha access_token com o UUID da página de configurações da API. O header é Authorization, sem prefixo Bearer. Nos Módulos de Aceite e de Notificação, preencha api_key e api_secret. Os headers são X-API-Key e X-API-Secret.

O access token é o mesmo para a API v3, o ClickFlow e o Módulo de Coleta de Dados (ClickForm). O host do environment muda por produto. Para obter o access token, veja Access token.

A API v3 tem Postman e Insomnia. Não tem collection Bruno. O ClickFlow, o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação têm os três. No Bruno, abra a pasta bruno do produto e escolha o environment de sandbox. No ClickFlow e no Módulo de Coleta de Dados (ClickForm), preencha access_token. No Aceite, preencha api_key e api_secret.

O que cada collection cobre

API v3. Envelopes, documentos, signatários, notificações, observadores e gerenciamento de usuários. Host de sandbox: sandbox.clicksign.com. O formato JSON:API e os hosts estão em Ambientes, autenticação e formato.

ClickFlow. Uma collection do Orquestrador (flows e execuções) e outra do Executor (disparo e acompanhamento). Hosts de sandbox: clickflow-sandbox.clicksign.com e clickflow-runner-sandbox.clicksign.com.

Módulo de Coleta de Dados (ClickForm). Formulários, versões e runs. Host de sandbox: clickform-sandbox.clicksign.com.

Módulos de Aceite e de Notificação. Criação, status e consulta da comunicação. No ClickFlow, o step é consent. Host de sandbox: app-acceptance-sandbox.clicksign.com.

Produção do ClickFlow, do Módulo de Coleta de Dados (ClickForm) e dos Módulos de Aceite e de Notificação só é liberada para quem contratou o produto. A comparação de hosts está em Informações gerais.

Próximo passo

• Primeiros passos da API v3
• Primeiros passos do ClickFlow
• Primeiros passos do Módulo de Coleta de Dados (ClickForm)
• Primeiros passos dos Módulos de Aceite e de Notificação