AgencyHandy API: Todentaminen ja aloittaminen

AgencyHandy API:n avulla voit automatisoida liidien luomista, asiakashallintaa, tilausten päivityksiä ja paljon muuta mistä tahansa ulkoisesta järjestelmästä tai skriptistä. Jokainen pyyntö todennetaan API-avaimella, jonka luot työtilasi asetuksista. Tämä opas opastaa sinua tunnistetietojen hankkimisessa ja ensimmäisen API-kutsun tekemisessä.

Sinun on oltava AgencyHandy-työtilasi SuperAdmin tai Admin luodaksesi API-avaimen.

Perus-URL

Kaikki API-pyynnöt tehdään osoitteeseen:

https://api.agencyhandy.com

Korvaa {{URL}} tällä perus-URL:lla kaikissa API-dokumentaation esimerkkipyynnöissä.

Vaihe 1: Luo API-avain

Avaa työtilan määritykset

Siirry työtilasi asetuksiin osoitteessa:

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

Tämä avaa API Key -välilehden työtilan määrityksessä.

Luo ja kopioi API-avaimesi

Napsauta Generate (tai Regenerate, jos avain on jo olemassa). Kopioi API-avain ja säilytä se turvallisesti — käsittele sitä kuin salasanaa. AgencyHandy ei näytä sitä uudelleen sen jälkeen, kun poistut sivulta.

API-avaimen uudelleenluominen mitätöi edellisen avaimen välittömästi. Kaikki vanhan avaimen käyttävät integraatiot lakkaavat toimimasta, kunnes päivität ne uudella avaimella.

Vaihe 2: Hae yritystunnuksesi

Useimmat API-päätepisteet vaativat companyid-otsikon, joka tunnistaa, minkä työtilan pyyntö kohdistuu. Käytä seuraavaa päätepistettä yritystunnuksesi hakemiseen.

Päätepiste

GET {{URL}}/accounts/companies

Otsikot

Otsikko	Arvo
`x-api-key`	API-avaimesi

Esimerkkipyyntö

cURL

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

Esimerkkivastaus

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

Paikanna yritystunnuksesi

Vastauksessa etsi _id-kenttä companies-taulukon sisältä. Tämä on yritystunnuksesi.

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

Tallenna yritystunnus

Tallenna yritystunnus käytettäväksi kaikissa myöhemmissä API-pyynnöissä. Välität sen companyid-otsikkona:

Otsikko	Arvo
`x-api-key`	API-avaimesi
`companyid`	Yritystunnuksesi

Todentamisen yhteenveto

Jokainen todennettu API-pyyntö vaatii vähintään:

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

API-avaimen ja yritystunnuksen kanssa olet valmis käyttämään muuta AgencyHandy API:a. Jatka johonkin alla olevista päätepisteoppaista.

Johdanto

Endpoints

AgencyHandy API: Todentaminen ja aloittaminen

Perus-URL

Vaihe 1: Luo API-avain

Vaihe 2: Hae yritystunnuksesi

Päätepiste

Otsikot

Esimerkkipyyntö

Esimerkkivastaus

Todentamisen yhteenveto

​Perus-URL

​Vaihe 1: Luo API-avain

​Vaihe 2: Hae yritystunnuksesi

​Päätepiste

​Otsikot

​Esimerkkipyyntö

​Esimerkkivastaus

​Todentamisen yhteenveto

Perus-URL

Vaihe 1: Luo API-avain

Vaihe 2: Hae yritystunnuksesi

Päätepiste

Otsikot

Esimerkkipyyntö

Esimerkkivastaus

Todentamisen yhteenveto