Comece aqui
Autenticação
Como gerar, enviar e revogar a chave da API Pública.
Toda requisição precisa de uma chave de API da empresa, no formato tf_live_ seguido de 48 caracteres.
Gerar uma chave
Seção intitulada “Gerar uma chave”- Entre na TakeFlow com um usuário administrador.
- Abra Administração > Dados da conta > Integrações.
- Clique no card API Pública (TakeFlow API).
- No painel, clique em Nova chave, dê um nome que identifique o uso (por exemplo
Power BI Diretoria) e clique em Gerar chave. - Copie a chave exibida e guarde em um cofre de segredos. Ela aparece uma única vez: a TakeFlow guarda só um hash dela e mostra depois apenas o prefixo (
tf_live_1a2b3c…).
A API Pública precisa estar incluída no plano da empresa. Se não estiver, o painel mostra “Não habilitado para o seu plano” e não permite gerar chave: fale com o seu consultor TakeFlow.
Enviar a chave
Seção intitulada “Enviar a chave”Use um dos três headers (x-api-key, x-key-api ou Authorization: Bearer), em todas as requisições:
GET /public/v1/tags HTTP/1.1Host: api.takeflow.com.brx-api-key: tf_live_SUA_CHAVEGET /public/v1/tags HTTP/1.1Host: api.takeflow.com.brx-key-api: tf_live_SUA_CHAVEGET /public/v1/tags HTTP/1.1Host: api.takeflow.com.brAuthorization: Bearer tf_live_SUA_CHAVEDesativar e excluir
Seção intitulada “Desativar e excluir”- Desativar (switch ao lado da chave): a chave para de funcionar em até 2 segundos e volta ao ser reativada.
- Excluir (lixeira, com confirmação): definitivo. Use se a chave vazar.
- Nos dois casos a API responde
401comcode: API_KEY_INVALID.
As chaves geradas pelo painel não expiram: ficam válidas até serem desativadas ou excluídas.
Quando uma chave válida é recusada
Seção intitulada “Quando uma chave válida é recusada”| Situação | Status | code |
|---|---|---|
| Header ausente | 401 | API_KEY_MISSING |
| Chave inexistente, desativada ou excluída | 401 | API_KEY_INVALID |
| Chave com data de expiração vencida | 401 | API_KEY_EXPIRED |
| Plano da empresa sem API Pública | 403 | ENTITLEMENT_PUBLIC_API_DISABLED |
| Assinatura da empresa vencida | 403 | SUBSCRIPTION_EXPIRED |
| Empresa desativada | 403 | COMPANY_DISABLED |
Quando valem as mudanças:
- Chave desativada ou excluída, e API Pública ligada ou desligada no plano: em até 2 segundos.
- Vencimento da assinatura: na hora em que vence.
- Troca da empresa para outro plano, renovação ou alteração da assinatura, empresa desativada ou reativada: em até 60 segundos.
Último uso
Seção intitulada “Último uso”O painel mostra a data e hora do último uso de cada chave. O registro é atualizado no máximo uma vez por minuto por chave.