L’API AgencyHandy ti consente di automatizzare la creazione di lead, la gestione dei clienti, gli aggiornamenti degli ordini e altro ancora da qualsiasi sistema esterno o script. Ogni richiesta viene autenticata con una chiave API che generi dalle impostazioni del tuo workspace. Questa guida ti accompagna nell’ottenimento delle credenziali e nella prima chiamata API.
Devi essere SuperAdmin o Admin nel tuo workspace AgencyHandy per generare una chiave API.
URL di base
Tutte le richieste API vengono effettuate a:
https://api.agencyhandy.com
{{URL}} con questo URL di base in tutte le richieste di esempio presenti nella documentazione API.
Passo 1: Genera una chiave API
Apri la Configurazione del Workspace
Naviga alle impostazioni del tuo workspace all’indirizzo:{{workspaceUrl}}/workspace-config?tab=api-key
Genera e copia la tua chiave API
Clicca su Genera (o Rigenera se esiste già una chiave). Copia la chiave API e conservala in modo sicuro — trattala come una password. AgencyHandy non la mostrerà di nuovo dopo che avrai lasciato la pagina.
Rigenerare la tua chiave API invalida immediatamente la chiave precedente. Tutte le integrazioni esistenti che utilizzano la vecchia chiave smetteranno di funzionare finché non le aggiorni con la nuova chiave.
Passo 2: Recupera il tuo ID Azienda
La maggior parte degli endpoint API richiede un header companyid che identifica quale workspace è il destinatario della richiesta. Utilizza il seguente endpoint per ottenere il tuo ID Azienda.
Endpoint
GET {{URL}}/accounts/companies
| Header | Valore |
|---|
x-api-key | La tua chiave API |
Richiesta di esempio
curl --request GET "https://api.agencyhandy.com/accounts/companies" \
--header "x-api-key: <YOUR_API_KEY>"
Risposta di esempio
{
"message": "Companies associated with API token.",
"companies": [
{
"_id": "6525994184e9ddd79853450e",
"name": "onethread123",
"logo": "",
"extraSmallLogo": "",
"largeLogo": ""
}
]
}
Individua il tuo ID Azienda
Nella risposta, trova il campo _id all’interno dell’array companies. Questo è il tuo ID Azienda.const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"
Salva l'ID Azienda
Salva l’ID Azienda per utilizzarlo in tutte le successive richieste API. Lo passerai come header companyid:| Header | Valore |
|---|
x-api-key | La tua chiave API |
companyid | Il tuo ID Azienda |
Riepilogo dell’autenticazione
Ogni richiesta API autenticata richiede come minimo:
x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>
