ავტორიზაცია
CRM API-ს თითოეული მოთხოვნა გადასცემს ავტორიზაციის სათაურებს. რომელი სათაურებია საჭირო მეთოდისთვის, მითითებულია მის გვერდზე ბლოკში „ავტორიზაცია“.
ინტეგრაციები ავტორიზდებიან API-ტოკენით სათაურში Authorization. წვდომის ტოკენი token-access გაიცემა API-ით შესვლისას და განკუთვნილია იმ აპლიკაციებისთვის, რომლებიც მომხმარებლის სახელით მუშაობენ.
სათაურები
api-token
სათაური: Authorization · ფორმატი: fs_api_* · გამოიყენება მეთოდებში: 365
API-ტოკენი განყოფილებიდან api_tokens. სათაურის მნიშვნელობა Authorization — Bearer <ტოკენ>. პარტნიორის ტოკენი: თუ ტოკენის გაცემისას არჩეულია ქსელი, ის მუშაობს მხოლოდ ამ ქსელთან და სათაური chain საჭირო არ არის. თუ ქსელი არჩეული არ არის, ტოკენს აქვს წვდომა ანგარიშის ყველა ქსელზე, მაგრამ აქტიური ქსელი არ გააჩნია. ყველა მოთხოვნა, რომელსაც სჭირდება ქსელი, უნდა გადასცემდეს სათაურს chain, წინააღმდეგ შემთხვევაში ბრუნდება შეცდომა 117 field: chain. /chains აბრუნებს ანგარიშის ქსელებს; /chains.switch ტოკენისთვის მიუწვდომელია (შეცდომა 268).
მაგალითი
Authorization: Bearer fs_api_YOUR_TOKENlanguage
სათაური: language · გამოიყენება მეთოდებში: 374
პასუხის ენა — ISO 639-1 კოდი, მაგალითად ru
მაგალითი
language: karole
სათაური: role · გამოიყენება მეთოდებში: 374
მომხმარებლის როლი: partner ან affiliate
მაგალითი
role: partnerchain
სათაური: chain · გამოიყენება მეთოდებში: 0
ქსელი, რომელშიც სრულდება მოთხოვნა. სავალდებულოა მხოლოდ პარტნიორის ტოკენისთვის, რომელიც გაცემულია ქსელის არჩევის გარეშე; სხვა შემთხვევებში იგნორირდება
მაგალითი
chain: YOUR_TOKENსათაურების ნაკრები
მეთოდი იღებს ერთ-ერთ ნაკრებს. ნაკრები API-ტოკენით შესაფერისია ინტეგრაციებისთვის.
api-token + language + role | მეთოდები: 365 |
language + role | მეთოდები: 9 |
წვდომის შეცდომები
არასწორი, დაბლოკილი ან ვადაგასული ტოკენი და მოთხოვნა საჭირო სათაურის გარეშე აბრუნებს შეცდომას კოდით. კოდების მნიშვნელობები იხილეთ განყოფილებაში „შეცდომები“.
შეცდომები →