Base URL, autenticacao e IDs

Suporte

Suporte

Última atualização em Jun 1, 2026

Base URL, autenticacao e IDs

Os exemplos da API IAra usam a URL da plataforma Digi2B:

export BASE_URL="https://app.digi2b.com"
export ACCOUNT_ID="59"
export API_TOKEN="seu_token_da_iara"

Application API

Use para automacoes autenticadas no escopo da conta:

/api/v1/accounts/:account_id

Autenticacao:

-H "api_access_token: $API_TOKEN"

Client API

Use para experiencias proprias de chat em uma caixa de API ja configurada:

/public/api/v1/inboxes/:inbox_identifier

A Client API usa inbox_identifier, contact_identifier e, quando habilitado, identifier_hash.

IDs comuns

ID Onde aparece
account_id URL da conta e rotas autenticadas
inbox_id Caixas/canais da conta
inbox_identifier Caixa de API para Client API
contact_id Contato dentro da conta
conversation_id Conversa interna
display_id Numero visivel da conversa no painel
agent_id Agente da conta
team_id Time da conta

Primeiro teste

curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/inboxes" \
  -H "api_access_token: $API_TOKEN"

Se esse teste falhar, confira token, conta, permissao do usuario e ambiente antes de seguir.