Começando

O caminho mínimo para colocar a primeira integração no ar: conceitos, chave de API e permissões.

Esta seção cobre tudo o que é necessário antes da primeira chamada de verdade: entender como os termos do painel se traduzem em recursos da API, criar e proteger uma chave e escolher as permissões que a integração precisa.

O caminho mínimo

Passo	O que fazer	Onde
1	Identificar os recursos e coletar os ids do funil e dos estágios	Primeiros passos
2	Criar a chave em API ▸ Chaves e guardá-la	Autenticação
3	Conceder à chave apenas os escopos necessários	Escopos e permissões
4	Validar com uma chamada de leitura	comando abaixo

curl -H "Authorization: Bearer SUA_CHAVE" \
  "https://app-api.atendeserver.com.br/v1/leads?per_page=1"

Checklist antes de codificar

• Chave criada e armazenada em variável de ambiente ou cofre de segredos

• Escopos revisados: uma chave por integração, apenas com o que ela usa

• kanban_id e kanban_status_id dos estágios anotados

• Campos personalizados já cadastrados no painel, se a integração usar custom_fields

• Tratamento previsto para 401, 403, 422 e 429

O que vem depois

Com a chave funcionando, siga para Referência para entender os envelopes de resposta, a paginação e o modelo de erros, que valem para todos os endpoints.

Nesta seção