Met de AgencyHandy API kunt u het aanmaken van leads, klantbeheer, bestelling-updates en meer automatiseren vanuit elk extern systeem of script. Elk verzoek wordt geauthenticeerd met een API-sleutel die u genereert vanuit uw werkruimte-instellingen. Deze gids leidt u door het verkrijgen van uw inloggegevens en het uitvoeren van uw eerste API-aanroep.
U moet SuperAdmin of Admin zijn in uw AgencyHandy-werkruimte om een API-sleutel te genereren.
Basis-URL
Alle API-verzoeken worden gedaan naar:
https://api.agencyhandy.com
{{URL}} door deze basis-URL in alle voorbeeldverzoeken in de API-documentatie.
Stap 1: Genereer een API-sleutel
Open Werkruimteconfiguratie
Navigeer naar uw werkruimte-instellingen via:{{workspaceUrl}}/workspace-config?tab=api-key
Genereer en kopieer uw API-sleutel
Klik op Genereren (of Opnieuw genereren als er al een sleutel bestaat). Kopieer de API-sleutel en bewaar deze veilig — behandel deze als een wachtwoord. AgencyHandy toont de sleutel niet opnieuw nadat u de pagina verlaat.
Het opnieuw genereren van uw API-sleutel maakt de vorige sleutel onmiddellijk ongeldig. Bestaande integraties die de oude sleutel gebruiken, werken niet meer totdat u ze bijwerkt met de nieuwe sleutel.
Stap 2: Haal uw Bedrijfs-ID op
De meeste API-eindpunten vereisen een companyid-header die aangeeft op welke werkruimte het verzoek is gericht. Gebruik het volgende eindpunt om uw Bedrijfs-ID op te halen.
Eindpunt
GET {{URL}}/accounts/companies
| Header | Waarde |
|---|
x-api-key | Uw API-sleutel |
Voorbeeldverzoek
curl --request GET "https://api.agencyhandy.com/accounts/companies" \
--header "x-api-key: <YOUR_API_KEY>"
Voorbeeldantwoord
{
"message": "Companies associated with API token.",
"companies": [
{
"_id": "6525994184e9ddd79853450e",
"name": "onethread123",
"logo": "",
"extraSmallLogo": "",
"largeLogo": ""
}
]
}
Zoek uw Bedrijfs-ID op
Zoek in het antwoord het veld _id binnen de array companies. Dit is uw Bedrijfs-ID.const companyId = response.companies[0]._id;
// bijv. "6525994184e9ddd79853450e"
Bewaar de Bedrijfs-ID
Sla de Bedrijfs-ID op voor gebruik in alle volgende API-verzoeken. U geeft deze door als de companyid-header:| Header | Waarde |
|---|
x-api-key | Uw API-sleutel |
companyid | Uw Bedrijfs-ID |
Samenvatting authenticatie
Elk geauthenticeerd API-verzoek vereist minimaal:
x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>
