Primeiros passos

Equivalência entre os termos do painel e os recursos da API, pré-requisitos da integração e a primeira requisição.

Termos do produto × recursos da API

No painel	Na API	Identificador
Contato	lead	lead_id / rotas /v1/leads
Empresa	company	company_id
Negociação	deal	deal_id / rotas /v1/deals
Funil	kanban	kanban_id
Estágio (coluna do funil)	kanban status	kanban_status_id
Origem	source	source_id
Usuário da conta	user / owner	owner_id, user_id

O que você precisa antes de começar

1

Uma chave de API

Crie a chave no painel em API ▸ Chaves (veja Autenticação).

2

Os ids do funil

Abra o funil no painel: o id aparece na URL (/dashboard/funis/{kanban_id}/...) e os ids dos estágios ficam nas configurações do funil.

Depois de criada, toda negociação também retorna seu kanban_id e kanban_status_id atuais em qualquer GET /v1/deals/{id}.

3

Campos personalizados já cadastrados

Caso a integração use custom_fields, cadastre os campos previamente. A API nunca cria campos personalizados; chaves desconhecidas retornam erro 422.

Primeira requisição

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

Recebeu um envelope { "data": [...], "meta": {...} }? A chave está válida e com o escopo leads de leitura. Siga para Convenções.