Principal Como solicitar um Eddie ao time Cloud Humans Quais são os requisitos de API para utilização no Eddie

Quais são os requisitos de API para utilização no Eddie

Última atualização em May 21, 2026

Quando usar

  • Você está preparando a especificação técnica de um fluxo Eddie que consome API externa
  • Você precisa saber quais informações sua documentação de API deve conter para acelerar a integração
  • Você quer um checklist dos campos, autenticação e tratamento de erros mínimos

Pré-requisitos

Sobre este artigo

Para configurar o Eddie com qualquer API, precisamos que a documentação forneça um conjunto mínimo de dados. Este artigo descreve o que enviar ao seu Account Manager, para que o time técnico da Cloud Humans consiga integrar a API rapidamente.

Documento modelo: Documento de Especificação de API — preencha-o conforme orientação e submeta ao seu AM.

Detalhes

1 — Endpoint da API

  • Base URL principal

  • Endpoint específico que será utilizado pelo Eddie

2 — Onde obter ou gerar a chave de acesso

API Key

  • Informações sobre onde gerar ou acessar a chave da API

  • Caso já possua a chave, basta enviá-la com segurança

Token gerado dinamicamente

Se a API exigir token gerado via outro endpoint, precisamos:

  • Endpoint responsável pela geração do token

  • Credenciais necessárias

  • Formato do retorno esperado

3 — Documentação da API

A documentação deve estar atualizada e conter:

  • Descrição dos endpoints

  • Métodos suportados (GET, POST, PUT, DELETE)

  • Exemplo de payload recente

  • Estrutura dos campos que o Eddie precisará extrair

4 — Parâmetros para teste

Exemplos de parâmetros para testar a integração:

  • E-mail

  • CPF

  • Número de pedido

  • Outros identificadores usados pela API

5 — Exemplos de documentação ideal

Uma documentação ideal deve conter:

  • Base URL + endpoints detalhados

  • Método (GET, POST, PUT, DELETE)

  • Headers necessários

  • Exemplo de request (JSON)

  • Exemplo de response (JSON)

  • Explicação campo a campo

  • Fluxo de autenticação (se houver)

6 — Erros comuns e como tratá-los

A documentação deve listar os principais erros retornados pela API, com explicações claras para conseguirmos identificar, interpretar e corrigir.

Códigos HTTP mais comuns

Código Significado
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
422 Unprocessable Entity
429 Too Many Requests
500 Internal Server Error

Descrição da causa provável

Para cada erro:

  • Parâmetros inválidos ou ausentes

  • Falha de autenticação ou token expirado

  • Excesso de requisições (rate limit)

  • Endpoint temporariamente indisponível

  • Erro interno do servidor da API

Exemplo de resposta de erro

JSON retornado e os campos relevantes (error, message, code etc.).

Orientações de correção

Como tratar:

  • Gerar ou renovar o token

  • Ajustar parâmetros obrigatórios

  • Aguardar alguns segundos antes de reenviar (em caso de 429)

Observações