AgencyHandy API: Autentisering och kom igång

AgencyHandy API låter dig automatisera skapandet av leads, klienthantering, orderuppdateringar och mer från vilket externt system eller skript som helst. Varje begäran autentiseras med en API-nyckel som du genererar från dina arbetsyteinställningar. Den här guiden visar dig hur du skaffar dina inloggningsuppgifter och gör ditt första API-anrop.

Du måste vara SuperAdmin eller Admin på din AgencyHandy-arbetsyta för att generera en API-nyckel.

Bas-URL

Alla API-begäranden görs till:

https://api.agencyhandy.com

Ersätt {{URL}} med denna bas-URL i alla exempelbegäranden i API-dokumentationen.

Steg 1: Generera en API-nyckel

Öppna arbetsytekonfiguration

Navigera till dina arbetsyteinställningar på:

{{workspaceUrl}}/workspace-config?tab=api-key

Detta öppnar fliken API-nyckel i Arbetsytekonfiguration.

Generera och kopiera din API-nyckel

Klicka på Generera (eller Regenerera om en nyckel redan finns). Kopiera API-nyckeln och förvara den säkert — behandla den som ett lösenord. AgencyHandy visar den inte igen efter att du lämnat sidan.

Om du regenererar din API-nyckel ogiltigförklaras den tidigare nyckeln omedelbart. Alla befintliga integrationer som använder den gamla nyckeln slutar fungera tills du uppdaterar dem med den nya nyckeln.

Steg 2: Hämta ditt företags-ID

De flesta API-endpoints kräver ett companyid-huvud som identifierar vilken arbetsyta begäran riktar sig mot. Använd följande endpoint för att hämta ditt företags-ID.

Endpoint

GET {{URL}}/accounts/companies

Huvuden

Huvud	Värde
`x-api-key`	Din API-nyckel

Exempelbegäran

cURL

curl --request GET "https://api.agencyhandy.com/accounts/companies" \
  --header "x-api-key: <YOUR_API_KEY>"

Exempelsvar

{
  "message": "Companies associated with API token.",
  "companies": [
    {
      "_id": "6525994184e9ddd79853450e",
      "name": "onethread123",
      "logo": "",
      "extraSmallLogo": "",
      "largeLogo": ""
    }
  ]
}

Hitta ditt företags-ID

I svaret, hitta fältet _id inuti companies-arrayen. Det här är ditt företags-ID.

const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"

Spara företags-ID:t

Spara företags-ID:t för användning i alla efterföljande API-begäranden. Du skickar det som companyid-huvudet:

Huvud	Värde
`x-api-key`	Din API-nyckel
`companyid`	Ditt företags-ID

Sammanfattning av autentisering

Varje autentiserad API-begäran kräver som minimum:

x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>

Med din API-nyckel och ditt företags-ID är du redo att använda resten av AgencyHandy API. Fortsätt till någon av endpoint-guiderna nedan.

Introduktion

Endpoints

AgencyHandy API: Autentisering och kom igång

Bas-URL

Steg 1: Generera en API-nyckel

Steg 2: Hämta ditt företags-ID

Endpoint

Huvuden

Exempelbegäran

Exempelsvar

Sammanfattning av autentisering

​Bas-URL

​Steg 1: Generera en API-nyckel

​Steg 2: Hämta ditt företags-ID

​Endpoint

​Huvuden

​Exempelbegäran

​Exempelsvar

​Sammanfattning av autentisering

Bas-URL

Steg 1: Generera en API-nyckel

Steg 2: Hämta ditt företags-ID

Endpoint

Huvuden

Exempelbegäran

Exempelsvar

Sammanfattning av autentisering