AgencyHandy API lader dig automatisere oprettelse af leads, klientadministration, ordreopdateringer og meget mere fra ethvert eksternt system eller script. Hver anmodning godkendes med en API-nøgle, som du genererer fra dine workspace-indstillinger. Denne vejledning guider dig gennem at hente dine legitimationsoplysninger og foretage dit første API-kald.
Du skal være SuperAdmin eller Admin på dit AgencyHandy-workspace for at generere en API-nøgle.
Basis-URL
Alle API-anmodninger foretages til:
https://api.agencyhandy.com
{{URL}} med denne basis-URL i alle eksempelanmodninger i hele API-dokumentationen.
Trin 1: Generer en API-nøgle
Åbn workspace-konfiguration
Naviger til dine workspace-indstillinger på:{{workspaceUrl}}/workspace-config?tab=api-key
Generer og kopiér din API-nøgle
Klik på Generate (eller Regenerate, hvis der allerede eksisterer en nøgle). Kopiér API-nøglen og opbevar den sikkert — behandl den som en adgangskode. AgencyHandy vil ikke vise den igen, når du forlader siden.
Regenerering af din API-nøgle ugyldiggør straks den tidligere nøgle. Alle eksisterende integrationer, der bruger den gamle nøgle, holder op med at virke, indtil du opdaterer dem med den nye nøgle.
Trin 2: Hent dit Company ID
De fleste API-endpoints kræver en companyid-header, der identificerer, hvilket workspace anmodningen er rettet mod. Brug følgende endpoint til at hente dit Company ID.
Endpoint
GET {{URL}}/accounts/companies
| Header | Værdi |
|---|
x-api-key | Din API-nøgle |
Eksempelanmodning
curl --request GET "https://api.agencyhandy.com/accounts/companies" \
--header "x-api-key: <YOUR_API_KEY>"
Eksempelsvar
{
"message": "Companies associated with API token.",
"companies": [
{
"_id": "6525994184e9ddd79853450e",
"name": "onethread123",
"logo": "",
"extraSmallLogo": "",
"largeLogo": ""
}
]
}
Find dit Company ID
I svaret skal du finde feltet _id inde i companies-arrayet. Dette er dit Company ID.const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"
Gem Company ID'et
Gem Company ID’et til brug i alle efterfølgende API-anmodninger. Du sender det som companyid-headeren:| Header | Værdi |
|---|
x-api-key | Din API-nøgle |
companyid | Dit Company ID |
Oversigt over godkendelse
Alle godkendte API-anmodninger kræver som minimum:
x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>
