Skip to main content
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:
Substitua {{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

1

Abrir a Configuração do Workspace

Navegue para as definições do seu workspace em:
Isto abre o separador Chave de API dentro da Configuração do Workspace.
2

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

​
Cabeçalhos

​
Exemplo de pedido

cURL

​
Exemplo de resposta

1

Localizar o seu ID de Empresa

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

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:

​
Resumo de autenticação

Cada pedido autenticado à API requer, no mínimo:
Com a sua chave de API e ID de Empresa disponíveis, está pronto para utilizar o resto da API do AgencyHandy. Continue para um dos guias de endpoints abaixo.