1.3. Informações gerais

Esta seção reúne o que a integração precisa saber antes do passo a passo de cada produto.

• Access token mostra como criar a conta de sandbox, gerar o token e associar o usuário à API. Esse access token vale para a API v3, o ClickFlow e o Módulo de Coleta de Dados (ClickForm). Os Módulos de Aceite e de Notificação autenticam com X-API-Key e X-API-Secret.
• Segurança descreve o TLS e as cifras aceitas na conexão.
• Limite de requisições descreve o rate limit de cada ambiente.
• Integração resiliente explica como tentar de novo com backoff e jitter, e traz uma demo local.
• Suporte indica como pedir ajuda.
• FAQ: dúvidas gerais responde o que vale para qualquer produto: ambientes, token, autenticação e suporte.

Hosts

O host muda por produto e por ambiente. O sandbox de um produto não é o sandbox do outro. Na API v3, no ClickFlow e no Módulo de Coleta de Dados (ClickForm), o access token é um só.

A versão vai no path. A API v3 usa /api/v3. O ClickFlow, o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação usam /api/v1.

Na API v3, no ClickFlow e no Módulo de Coleta de Dados (ClickForm), o header é Authorization, com o UUID do access token e sem prefixo Bearer. Nos Módulos de Aceite e de Notificação, os headers são X-API-Key e X-API-Secret.

O sandbox está liberado para testes. Em produção, o ClickFlow, o Módulo de Coleta de Dados (ClickForm) e os Módulos de Aceite e de Notificação só funcionam para quem contratou o produto. A contratação é independente da API v3. O detalhe de cada um está nos primeiros passos: API v3, ClickFlow, Módulo de Coleta de Dados (ClickForm) e Módulos de Aceite e de Notificação.

Hosts, JSON:API e o formato de data da API v3 estão em Ambientes, autenticação e formato.