Մուտք

CRM API-ին յուրաքանչյուր հարցում փոխանցում է վավերացման վերնագրեր։ Որ վերնագրերն են անհրաժեշտ տվյալ մեթոդին, նշված է նրա էջում «Վավերացում» բաժնում։.

Ինտեգրացիաները նույնականացվում են API նշանով Authorization վերնագրում։ Մուտքի նշանը token-access տրվում է API-ի միջոցով մուտք գործելիս և հարմար է այն հավելվածների համար, որոնք աշխատում են օգտագործողի անունից։.

Վերնագրեր

`api-token`

Վերնագիր: Authorization · Ձևաչափ: fs_api_* · Օգտագործվում է մեթոդներում՝ 47

API-token-ը api_tokens բաժնից։ Authorization վերնագրի արժեքը՝ Bearer <token>։ Գործընկերոջ token՝ եթե token-ը տրամադրելիս ընտրված է ցանց, այն աշխատում է միայն այդ ցանցի հետ, և chain վերնագիրը անհրաժեշտ չէ։ Եթե ցանցը ընտրված չէ, token-ը ունի մուտք բոլոր ցանցերին, սակայն ակտիվ ցանց չունի։ Յուրաքանչյուր հարցում, որին անհրաժեշտ է ցանց, պետք է փոխանցի chain վերնագիրը, հակառակ դեպքում վերադարձվում է սխալ 117՝ field: chain։ /chains վերադարձնում է հաշվի ցանցերը; /chains.switch token-ին հասանելի չէ (սխալ 268)։.

Օրինակ

Authorization: Bearer fs_api_YOUR_TOKEN

`language`

Վերնագիր: language · Օգտագործվում է մեթոդներում՝ 56

Պատասխանի լեզուն՝ ISO 639-1 կոդ, օրինակ՝ ru

Օրինակ

language: hy

`role`

Վերնագիր: role · Օգտագործվում է մեթոդներում՝ 56

Օգտագործողի դեր՝ partner կամ affiliate

Օրինակ

role: affiliate

`chain`

Վերնագիր: chain · Օգտագործվում է մեթոդներում՝ 0

Այն ցանցը, որտեղ կատարվում է հարցումը։ Պահանջվում է միայն այն դեպքում, երբ գործընկերոջ նշանը տրվել է առանց ցանցի ընտրության. մյուս դեպքերում անտեսվում է։

Օրինակ

chain: YOUR_TOKEN

Վերնագրերի հավաքածուներ

Մեթոդը ընդունում է հավաքածուներից մեկը։ API նշանով հավաքածուները հարմար են ինտեգրացիաների համար։.

`api-token` + `language` + `role`	մեթոդներ՝ 47
`language` + `role`	մեթոդներ՝ 9

Մուտքի սխալներ

Սխալ, արգելափակված կամ ժամկետանց նշանը, ինչպես նաև անհրաժեշտ վերնագրի բացակայությամբ հարցումը վերադարձնում է սխալի կոդով պատասխան։ Կոդերի նշանակությունները ներկայացված են «Սխալներ» բաժնում։.

Սխալներ →