Autorizacija

Kiekvienas užklausimas į CRM API perduoda autorizacijos antraštes. Kokios antraštės reikalingos metodui, nurodyta jo puslapyje skyriuje „Autorizacija“.

Integracijos autorizuojamos API žetonu antraštėje Authorization. Prieigos žetonas token-access išduodamas prisijungiant per API ir tinka programoms, kurios veikia vartotojo vardu.

Antraštės

`api-token`

Antraštė: Authorization · Formatas: fs_api_* · Naudojama metoduose: 47

API raktas iš skyriaus api_tokens. Antraštės Authorization reikšmė — Bearer <raktas>. Partnerio raktas: jei išduodant raktą pasirinktas tinklas, jis veikia tik su tuo tinklu ir antraštė chain nereikalinga. Jei tinklas nepasirinktas, raktas turi prieigą prie visų paskyros tinklų, bet neturi aktyvaus tinklo. Kiekviena užklausa, kuriai reikia tinklo, turi perduoti antraštę chain, kitaip grąžinama klaida 117 su field: chain. /chains grąžina paskyros tinklus; /chains.switch raktui neprieinamas (klaida 268).

Pavyzdys

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Antraštė: language · Naudojama metoduose: 56

Atsakymo kalba – ISO 639-1 kodas, pvz., ru

Pavyzdys

language: lt

`role`

Antraštė: role · Naudojama metoduose: 56

Vartotojo vaidmuo: partner arba affiliate

Pavyzdys

role: affiliate

`chain`

Antraštė: chain · Naudojama metoduose: 0

Tinklas, kuriame vykdomas užklausa. Privalomas tik partnerio žetonui, išduotam be tinklo pasirinkimo; kitais atvejais ignoruojamas

Pavyzdys

chain: YOUR_TOKEN

Antraščių rinkiniai

Metodas priima vieną iš rinkinių. Rinkiniai su API žetonu tinka integracijoms.

`api-token` + `language` + `role`	metodų: 47
`language` + `role`	metodų: 9

Prieigos klaidos

Neteisingas, užblokuotas arba pasibaigusio galiojimo žetonas ir užklausa be reikiamos antraštės grąžina klaidą su kodu. Kodų reikšmės pateiktos skyriuje „Klaidų“.

Klaidų →