A API do AgencyHandy permite-lhe automatizar a criação de leads, a gestão de clientes, as atualizações de encomendas e muito mais a partir de qualquer sistema externo ou script. Cada pedido é autenticado com uma chave de API que gera nas definições do seu workspace. Este guia orienta-o na obtenção das suas credenciais e na realização da sua primeira chamada à API.
Tem de ser SuperAdmin ou Admin no seu workspace AgencyHandy para gerar uma chave de API.
URL Base
Todos os pedidos à API são feitos para:
https://api.agencyhandy.com
{{URL}} por este URL base em todos os pedidos de exemplo ao longo da documentação da API.
Passo 1: Gerar uma chave de API
Abrir a Configuração do Workspace
Navegue para as definições do seu workspace em:{{workspaceUrl}}/workspace-config?tab=api-key
Gerar e copiar a sua chave de API
Clique em Gerar (ou Regenerar se já existir uma chave). Copie a chave de API e guarde-a em segurança — trate-a como uma palavra-passe. O AgencyHandy não a voltará a mostrar depois de sair da página.
Regenerar a sua chave de API invalida imediatamente a chave anterior. Quaisquer integrações existentes que utilizem a chave antiga deixarão de funcionar até as atualizar com a nova chave.
Passo 2: Obter o seu ID de Empresa
A maioria dos endpoints da API requer um cabeçalho companyid que identifica qual workspace é o alvo do pedido. Utilize o seguinte endpoint para obter o seu ID de Empresa.
Endpoint
GET {{URL}}/accounts/companies
Cabeçalhos
| Cabeçalho | Valor |
|---|
x-api-key | A sua chave de API |
Exemplo de pedido
curl --request GET "https://api.agencyhandy.com/accounts/companies" \
--header "x-api-key: <YOUR_API_KEY>"
Exemplo de resposta
{
"message": "Companies associated with API token.",
"companies": [
{
"_id": "6525994184e9ddd79853450e",
"name": "onethread123",
"logo": "",
"extraSmallLogo": "",
"largeLogo": ""
}
]
}
Localizar o seu ID de Empresa
Na resposta, encontre o campo _id dentro do array companies. Este é o seu ID de Empresa.const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"
Guardar o ID de Empresa
Guarde o ID de Empresa para utilizar em todos os pedidos de API subsequentes. Irá passá-lo como cabeçalho companyid:| Cabeçalho | Valor |
|---|
x-api-key | A sua chave de API |
companyid | O seu ID de Empresa |
Resumo de autenticação
Cada pedido autenticado à API requer, no mínimo:
x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>
