Skip to main content
A API do AgencyHandy permite automatizar a criação de leads, o gerenciamento de clientes, atualizações de pedidos e muito mais a partir de qualquer sistema externo ou script. Cada requisição é autenticada com uma chave de API que você gera nas configurações do seu workspace. Este guia mostra como obter suas credenciais e fazer sua primeira chamada de API.
Você deve ser SuperAdmin ou Admin no seu workspace do AgencyHandy para gerar uma chave de API.

​
URL Base

Todas as requisições de API são feitas para:
Substitua {{URL}} por esta URL base em todas as requisições de exemplo ao longo da documentação da API.

​
Passo 1: Gerar uma chave de API

1

Abrir a Configuração do Workspace

Navegue até as configurações do seu workspace em:
Isso abre a aba Chave de API dentro da Configuração do Workspace.
2

Gerar e copiar sua chave de API

Clique em Gerar (ou Regenerar se já existir uma chave). Copie a chave de API e armazene-a com segurança — trate-a como uma senha. O AgencyHandy não a exibirá novamente após você sair da página.
Regenerar sua chave de API invalida imediatamente a chave anterior. Quaisquer integrações existentes que usem a chave antiga pararão de funcionar até que você as atualize com a nova chave.

​
Passo 2: Recuperar seu ID de Empresa

A maioria dos endpoints da API requer um header companyid que identifica qual workspace a requisição tem como alvo. Use o seguinte endpoint para buscar seu ID de Empresa.

​
Endpoint

​
Headers

​
Exemplo de requisição

cURL

​
Exemplo de resposta

1

Localizar seu ID de Empresa

Na resposta, encontre o campo _id dentro do array companies. Este é seu ID de Empresa.
2

Armazenar o ID de Empresa

Salve o ID de Empresa para uso em todas as requisições de API subsequentes. Você o passará como o header companyid:

​
Resumo de autenticação

Toda requisição de API autenticada requer, no mínimo:
Com sua chave de API e ID de Empresa em mãos, você está pronto para usar o restante da API do AgencyHandy. Continue para um dos guias de endpoint abaixo.