API AgencyHandy umožňuje automatizovat vytváření leadů, správu klientů, aktualizace objednávek a další operace z libovolného externího systému nebo skriptu. Každý požadavek je ověřen pomocí API klíče, který vygenerujete v nastavení workspace. Tento průvodce vás provede získáním přihlašovacích údajů a prvním voláním API.
Chcete-li vygenerovat API klíč, musíte být SuperAdmin nebo Admin ve svém workspace AgencyHandy.
Základní URL
Všechny požadavky API jsou zasílány na:
https://api.agencyhandy.com
{{URL}} touto základní URL.
Krok 1: Vygenerujte API klíč
Otevřete Konfiguraci workspace
Přejděte do nastavení workspace na adrese:{{workspaceUrl}}/workspace-config?tab=api-key
Vygenerujte a zkopírujte svůj API klíč
Klikněte na Generovat (nebo Znovu generovat, pokud klíč již existuje). Zkopírujte API klíč a bezpečně jej uložte — zacházejte s ním jako s heslem. AgencyHandy jej po opuštění stránky znovu nezobrazí.
Opětovné vygenerování API klíče okamžitě zneplatní předchozí klíč. Všechny stávající integrace používající starý klíč přestanou fungovat, dokud je neaktualizujete novým klíčem.
Krok 2: Získejte ID společnosti
Většina API endpointů vyžaduje hlavičku companyid, která identifikuje, na který workspace požadavek cílí. Pomocí následujícího endpointu získáte své ID společnosti.
Endpoint
GET {{URL}}/accounts/companies
Hlavičky
| Hlavička | Hodnota |
|---|
x-api-key | Váš API klíč |
Ukázkový požadavek
curl --request GET "https://api.agencyhandy.com/accounts/companies" \
--header "x-api-key: <YOUR_API_KEY>"
Ukázková odpověď
{
"message": "Companies associated with API token.",
"companies": [
{
"_id": "6525994184e9ddd79853450e",
"name": "onethread123",
"logo": "",
"extraSmallLogo": "",
"largeLogo": ""
}
]
}
Vyhledejte své ID společnosti
V odpovědi najděte pole _id uvnitř pole companies. Toto je vaše ID společnosti.const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"
Uložte ID společnosti
Uložte ID společnosti pro použití ve všech následných požadavcích API. Budete jej předávat jako hlavičku companyid:| Hlavička | Hodnota |
|---|
x-api-key | Váš API klíč |
companyid | Vaše ID společnosti |
Souhrn ověřování
Každý ověřený požadavek API vyžaduje minimálně:
x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>
