Autorizācija

Katrs pieprasījums uz CRM API nosūta autorizācijas galvenes. Kādas galvenes ir nepieciešamas konkrētai metodei, ir norādīts tās lapā sadaļā "Autorizācija".

Integrācijas tiek autorizētas ar API pilnvaru galvenē Authorization. Piekļuves pilnvara token-access tiek izsniegta, piesakoties caur API, un tā ir piemērota lietotnēm, kas darbojas lietotāja vārdā.

Virsraksti

`api-token`

Virsraksts: Authorization · Formāts: fs_api_* · Tiek izmantots metodēs: 47

API marķieris no sadaļas api_tokens. Galvenes Authorization vērtība — Bearer <marķieris>. Partnera marķieris: ja marķiera izsniegšanas brīdī ir izvēlēts tīkls, tas darbojas tikai ar šo tīklu, un galvene chain nav nepieciešama. Ja tīkls nav izvēlēts, marķierim ir piekļuve visiem konta tīkliem, bet tam nav aktīvā tīkla. Katram pieprasījumam, kam nepieciešams tīkls, jānorāda galvene chain, pretējā gadījumā tiek atgriezta kļūda 117 ar field: chain. /chains atgriež konta tīklus; /chains.switch marķierim nav pieejams (kļūda 268).

Piemērs

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Virsraksts: language · Tiek izmantots metodēs: 56

Atbildes valoda — ISO 639-1 kods, piemēram, ru

Piemērs

language: lv

`role`

Virsraksts: role · Tiek izmantots metodēs: 56

Lietotāja loma: partner vai affiliate

Piemērs

role: affiliate

`chain`

Virsraksts: chain · Tiek izmantots metodēs: 0

Tīkls, kurā tiek izpildīts pieprasījums. Obligāts tikai partnera tokenam, kas izsniegts bez tīkla izvēles; citos gadījumos tiek ignorēts

Piemērs

chain: YOUR_TOKEN

Galvenes komplekti

Metode pieņem vienu no komplektiem. Komplekti ar API pilnvaru ir piemēroti integrācijām.

`api-token` + `language` + `role`	metodes: 47
`language` + `role`	metodes: 9

Piekļuves kļūdas

Nepareizs, bloķēts vai beidzies pilnvarojuma tokens, kā arī pieprasījums bez nepieciešamās galvenes atgriež kļūdu ar kodu. Kodu vērtības skatiet sadaļā “Kļūdas”.

Kļūdas →