შეტყობინებების რეგისტრაციის კატალოგების ჩატვირთვა

რეგისტრაციის ფორმის შექმნამდე ჩატვირთეთ არჩევის ვარიანტები

არჩევის ვარიანტების შესავსებად გამოიყენეთ შეტყობინებების რეგისტრაციის მიმდინარე კატალოგი და რეესტრის მნიშვნელობები კოდში ფიქსირებულად არ ჩაწეროთ. ბრენდის ფორმისთვის პორტალი ტვირთავს ბიზნესის ტიპის, საქმიანობის სფეროს, ბიზნესის ალტერნატიული იდენტიფიკატორის ტიპის, ბრენდთან ურთიერთობის, ქვეყნის, აშშ-ის შტატისა და საფონდო ბირჟის კატალოგებს. კამპანიის ფორმისთვის ის ტვირთავს გამოყენების შემთხვევებს, დასაშვებ ქვეშემთხვევებსა და კავშირის პარტნიორებს. თითოეული დაბრუნებული მანქანური მნიშვნელობა შეინახეთ მის საჩვენებელ წარწერასთან ერთად; შემდგომი მოთხოვნის შედგენისას გამოიყენეთ თვითონ მნიშვნელობა და არა თარგმნილი წარწერა.

აირჩიეთ კატალოგი

უშუალოდ დაამუშავეთ TCR-ის პასუხი

პასუხის შიგთავსი უშუალოდ TCR-ის API-ს ეკუთვნის. მრავალი ძველი /v3 წვდომის წერტილისგან განსხვავებით, მას არ აქვს დამატებული status/response გარსი. მის ინტერპრეტაციამდე შეამოწმეთ HTTP სტატუსი. კატალოგი შეიძლება შეიცავდეს სტრიქონულ წარწერებს ან სტრუქტურირებულ განსაზღვრებებს, ამიტომ ნუ ივარაუდებთ, რომ ყველა მნიშვნელობას ერთნაირი ველები აქვს. თუ HTTP მოთხოვნა წარმატებით სრულდება, მაგრამ შიგთავსი მოსალოდნელი სტრუქტურის მქონე ვალიდური JSON არ არის, აცნობეთ მონაცემების მოძიების წარუმატებლობის შესახებ და ჩუმად ნუ ჩაანაცვლებთ მას ცარიელი სიით.

კატალოგის არჩევის ვარიანტები გამიჯნეთ შესაბამისობის შემოწმებისა და ფასების განსაზღვრისგან

გამოყენების შემთხვევების ზოგადი კატალოგი არ მიუთითებს, რომელი გამოყენების შემთხვევებისთვის აკმაყოფილებს კონკრეტული ბრენდი მოთხოვნებს. მიმდინარე პორტალი კამპანიის შექმნამდე ამოწმებს კონკრეტული ბრენდის შესაბამისობას და შერჩეული ოპერატორის მოთხოვნებს. ასევე, მომწოდებლის საფასურის მეტამონაცემები ანგარიშის საბოლოო საცალო ფასი არ არის. ანგარიშისთვის მოქმედი ფასი და რეგისტრაციის პირობები ცალკე განიხილეთ. კატალოგის ჩატვირთვა ბრენდს, კამპანიას ან შეტყობინებების ნომერს არ ამტკიცებს.

დაამუშავეთ კატალოგების მიუწვდომლობა

თუ მონაცემების მოძიება ვერ მოხერხდა, შეინარჩუნეთ მომხმარებლის მიერ ფორმაში შეყვანილი მონაცემები. აჩვენეთ შეცდომა და გაითვალისწინეთ Retry-After დაბრუნების შემთხვევაში; განმეორებით მცდელობებს შორის დაყოვნება თანდათან გაზარდეთ. ნუ გადატვირთავთ ყველა კატალოგს განუწყვეტლივ და ნუ მიიჩნევთ მოთხოვნების სიხშირის შეზღუდვის ან ტრანსპორტის შეცდომას ცარიელ ვალიდურ კატალოგად. ამ GET მოთხოვნას იდემპოტენტურობის გასაღები არ სჭირდება და ის ცვლილების ოპერაციების იდემპოტენტურობის საცავიდან ხელახლა არ სრულდება.

მოთხოვნა

ნებადართული წყაროს IP მისამართიდან გამოიყენეთ ჩართული API ანგარიში HTTPS-ის საშუალებით. მიმდინარე მარშრუტი მხარს უჭერს ანგარიშის ავთენტიფიკაციის პოლიტიკას, მათ შორის Basic ავთენტიფიკაციასა და მატარებელი ტოკენით ავთენტიფიკაციისთვის ჩართულ API ანგარიშებს. არ გამოიყენოთ პროვაიდერის ავტორიზაციის მონაცემები.

გაგზავნეთ GET მოთხოვნა, რომლის გზაშიც მხარდაჭერილი კატალოგის სახელია მითითებული. შესაბამისი კატალოგის ფილტრები გადაეცით მოთხოვნის პარამეტრების სტრიქონში. მოთხოვნის შიგთავსი საჭირო არ არის.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

პასუხი

ეს TCR მარშრუტი პირდაპირ აბრუნებს რეესტრის შიგთავსს მისი HTTP სტატუსით. ის არ იყენებს ძველ v3 status.code/status.msg/response გარსს. კატალოგების სტრუქტურები განსხვავდება: ზოგი მნიშვნელობებს აღწერით ობიექტებს უსადაგებს, ზოგი კი — სტრიქონებს. შემდგომი ფორმის გაგზავნისას შეინარჩუნეთ მანქანურად წაკითხვადი გასაღებები. შემოკლებული გამოგონილი usecase მაგალითი ასახავს შესაბამისობას, რომლის მნიშვნელობებიც ობიექტებია, და არა მოქმედ კატალოგს ან გარანტირებულად სრულ სქემას. შეამოწმეთ როგორც HTTP სტატუსი, ისე მოსალოდნელი JSON სტრუქტურა.

პასუხის სტრუქტურის საილუსტრაციო მაგალითი; ეს არ არის ანგარიშის რეალური მონაცემები ან მიმდინარე ფასის შეთავაზება.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

შეცდომები

• 401: ანგარიშის ავთენტიფიკაცია ვერ მოხერხდა. შეამოწმეთ API ავტორიზაციის მონაცემები, ჩართულია თუ არა ანგარიში და წყაროს IP მისამართზე მოქმედი შეზღუდვები.
• 400/404 და რეესტრის სხვა შეცდომები: კატალოგი ან ფილტრი არასწორია ან მიუწვდომელია. მიმდინარე მარშრუტი ინარჩუნებს ზედა დონის სერვისის HTTP სტატუსსა და პასუხის შიგთავსს; შეცდომის უნივერსალური v3 გარსი არ არსებობს.
• 429: მიღწეულია ანგარიშის ან პროვაიდერის საერთო მოთხოვნების ლიმიტი. გაითვალისწინეთ Retry-After და ხელახლა სცადეთ მცდელობებს შორის დაყოვნების თანდათან გაზრდით.
• 502: რეესტრთან დაკავშირება ვერ მოხერხდა. ხელმისაწვდომობა უცნობია; წარმატებული შედეგის ნაცვლად არჩევის ცარიელ ვარიანტებს ნუ დააბრუნებთ.
• 503: მოთხოვნების შემზღუდველი ან ზედა დონის სერვისი მიუწვდომელია. ხელახლა ცდამდე შეამოწმეთ შიგთავსი და Retry-After სათაური, თუ ის არსებობს.

ხელმისაწვდომობა და თანმდევი ეფექტები

• განხილულ გზაზე კატალოგის ეს GET მოთხოვნა არ ქმნის ბრენდს ან კამპანიას, არ აგზავნის რეგისტრაციას, არ ჯავშნის რესურსს და არ აკისრებს რეგისტრაციის საფასურს. ის უკავშირდება პროვაიდერს და წერს მოთხოვნების აუდიტის ჩანაწერებს.
• კატალოგის განსაზღვრებები და მომწოდებლის საფასურის ნებისმიერი მეტამონაცემი მომხმარებლისთვის საცალო ფასის შეთავაზება არ არის. მიმდინარე პორტალი კამპანიის საცალო ფასებს ცალკე იღებს; მოძველებული getCampaignPrice დამხმარე ფუნქცია და ჩამონათვალების ძველი ფასის ანოტაციები ამ მარშრუტის ფასების განსაზღვრის კონტრაქტად არ უნდა ჩაითვალოს.
• კატალოგში მხარდაჭერილი ჩანაწერის არსებობა არ ადასტურებს, რომ კონკრეტული ბრენდი ამ გამოყენების შემთხვევის მოთხოვნებს აკმაყოფილებს. შემდგომი რეგისტრაციის მოთხოვნის გაგზავნამდე დაასრულეთ კონკრეტული ბრენდის შესაბამისობის შემოწმება, დეკლარაციები, თანხმობის მიღება და ანგარიშის ფასების განხილვა.