Autoriseerimine

Iga CRM API päring edastab autoriseerimispealkirjad. Milliseid pealkirju meetod vajab, on märgitud selle lehel jaotises „Autoriseerimine“.

Integratsioonid autoriseeritakse API-tokeni abil päises Authorization. Juurdepääsutoken token-access väljastatakse API kaudu sisselogimisel ning sobib rakendustele, mis töötavad kasutaja nimel.

Pealkirjad

`api-token`

Päis: Authorization · Vorming: fs_api_* · Kasutatakse meetodites: 365

API-token pärineb jaotisest api_tokens. Päise Authorization väärtus on Bearer <token>. Partneri token: kui tokeni väljastamisel valiti kett, töötab see ainult selle ketiga ja päist chain pole vaja. Kui kett ei ole valitud, on tokenil ligipääs kõigile konto kettidele, kuid aktiivset ketti pole. Iga päring, mis vajab ketti, peab saatma päise chain, vastasel juhul tagastatakse viga 117 koos field: chain. /chains tagastab konto ketid; /chains.switch pole tokenile saadaval (viga 268).

Näide

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Päis: language · Kasutatakse meetodites: 374

Vastuse keel – ISO 639-1 kood, näiteks ru

Näide

language: et

`role`

Päis: role · Kasutatakse meetodites: 374

Kasutaja roll: partner või affiliate

Näide

role: partner

`chain`

Päis: chain · Kasutatakse meetodites: 0

Võrk, milles päring sooritatakse. Nõutav ainult partneri tokeni puhul, mis on väljastatud ilma võrgu valikuta; muudel juhtudel eiratakse

Näide

chain: YOUR_TOKEN

Päiste komplektid

Meetod võtab vastu ühe komplektidest. Komplektid API-tokenniga sobivad integratsioonideks.

`api-token` + `language` + `role`	meetodit: 365
`language` + `role`	meetodit: 9

Juurdepääsuvead

Vale, blokeeritud või aegunud tunnus ning päring ilma vajaliku päisega tagastavad veakoodi. Koodide väärtused leiad jaotisest „Veateated“.

Veateated →