REST API დოკუმენტაცია

გადაუდებელი ზარის REST API-ები

დაარეგისტრირეთ ნომერი და სერვისის მისამართი, თვალი ადევნეთ მის აქტივაციის სტატუსს და განაახლეთ ჩანაწერი ადგილმდებარეობის ცვლილებისას.

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

API და მისი ავტორიზაციის მონაცემები ერთად შეარჩიეთ

დამტკიცებულ დეველოპერებისა და ავტომატიზაციის, ბიზნესისა და კომუნიკაციების პროვაიდერების ანგარიშებს ჩართული სერვისების ინტეგრირება შეუძლიათ. ინდივიდუალურ დეველოპერს კომპანიის სახელით თავის წარმოჩენა არ სჭირდება. აპლიკაციიდან SMS/MMS-ის გაგზავნას შესაბამისი დამტკიცება და რეგისტრაცია სჭირდება. ფიზიკური პირებისა და ოჯახების სერვისს მომხმარებლისთვის ხელმისაწვდომი შეტყობინებების გაგზავნის API არ აქვს.

API ოჯახი	საბაზო URL	ავთენტიფიკაცია და შედეგი
კომუნიკაციები v3	`https://api.multitel.net/v3`	დამტკიცებული Basic ავტორიზაციის მონაცემები; სპეციალურად გაცემული შესაბამისი ტოკენები მხოლოდ იმ ოპერაციებისთვის, რომლებიც მათ მხარს უჭერს. JSON `status` და `response`.
გადაუდებელი დახმარების სერვისში რეგისტრაცია	`https://api.multi.tel/emergency`	დამტკიცებული Basic ავტორიზაციის მონაცემები ან სპეციალურად ჩართული bearer წვდომა. JSON `code`, `message` და `data`.
პორტალის REST ინტეგრაციები	ჰოსტი და ოპერაცია ნაჩვენებია თქვენი ანგარიშის დეველოპერის ცნობარში	გამოიყენეთ კონკრეტული ოპერაციისთვის დოკუმენტირებული ავტორიზაციის მონაცემები, ნებართვის ფარგლები და სქემა. ბრაუზერის სესიის მოთხოვნები ცალკე ინტერფეისს განეკუთვნება.

მაგალითების გამოყენებამდე MULTITEL_API_USERNAME და MULTITEL_API_PASSWORD თქვენი სერვერის საიდუმლო კონფიგურაციის მეშვეობით დააყენეთ. არასოდეს ჩასვათ ისინი ბრაუზერის საჯარო JavaScript-ში, URL-ებში ან კოდის ვერსიების საცავში. სპეციალური ავტორიზაციის მონაცემები API ინტეგრაციის პარამეტრებში იმართება.

დაფარვის წაკითხვა ნომრის რეგისტრაციის გარეშე

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

ასევე მხარდაჭერილია https://api.multitel.net/emergency. გადაუდებელი დახმარების არცერთი საბაზო URL არ შეიცავს /v3-ს. დაფარვა ჩამოთვლის საერთაშორისო ქვეყნებს, მხარდაჭერილ ნომრის ტიპებსა და ფასებს; ჩრდილოამერიკული E911 უფლებამოსილება მოწმდება რეგისტრაციის დროს.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

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

დაარეგისტრირეთ, თვალყური ადევნეთ სტატუსს, შემდეგ დააკონფიგურირეთ ზარები

აშშ-ის, კანადისა და სხვა მხარდაჭერილი ჩრდილოეთ ამერიკის E911 რეგიონებისთვის მიუთითეთ ნომერი, E911 მისამართი და საჭირო თანხმობების დადასტურებები. ჩრდილოეთ ამერიკის E911 მხოლოდ რეალურ სამუშაო გარემოშია ხელმისაწვდომი.
თქვენს საკუთრებაში არსებული მხარდაჭერილი საერთაშორისო ნომრისთვის მიუთითეთ შენახული დოკუმენტის მითითება ან საბოლოო მომხმარებლის ვინაობა და მისამართი. ჯერ ქვეყნისა და ნომრის ტიპის მოთხოვნებს გაეცანით.
გაგზავნეთ ერთი POST /registrations მოთხოვნა. არასავალდებულო Idempotency-Key ერთ ლოგიკურ ცვლილებას განსაზღვრავს; განმეორებითი მცდელობებისას შეინარჩუნეთ როგორც ეს გასაღები, ისე მოთხოვნის ზუსტად იგივე მონაცემები.
წაიკითხეთ GET /registrations/:number. შეამოწმეთ სასიცოცხლო ციკლი, pending და actionRequired; მოაგვარეთ საჭირო შესწორებები. მიღება ან მომლოდინე მდგომარეობა არ არის აქტიური სერვისი.
აქტივაციის შემდეგ დააკონფიგურირეთ გადაუდებელი ზარისთვის სწორი გამომძახებლის იდენტიფიკატორი და შესაბამისი ქვეყნის აკრეფის მარშრუტი. გამოიყენეთ სერვისის შემოწმების პროცედურა, რომელიც გადაუდებელ სამსახურებში დარეკვას არ მოითხოვს.

საერთაშორისო სატესტო რეგისტრაციები იზოლირებულია და რეალურ გადაუდებელ ზარებს არ ააქტიურებს. ჩრდილოეთ ამერიკის E911-ისთვის მთავარი ანგარიშის ავტორიზაციის მონაცემებია საჭირო; გზამკვლევი განმარტავს საერთაშორისო ქვეანგარიშების შეზღუდულ მხარდაჭერას.

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

შეცდომებისა და განმეორებითი მცდელობების დამუშავება

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

იდემპოტენტურობის მხარდაჭერა API-ის თითოეულ ოჯახზეა დამოკიდებული. Emergency API განმეორებითი მცდელობების გასაღებებს უჭერს მხარს; ეს არ ნიშნავს, რომ ყველა v3 მოთხოვნა იდემპოტენტურია. მხარდაჭერისთვის შეინახეთ დროის ნიშნულები, დაბრუნებული ID-ები და პასუხები, საიდანაც საიდუმლო მონაცემები ამოღებულია.

გააგრძელეთ თქვენი ანგარიშის საცნობარო მასალით

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

თქვენი ანგარიშისთვის განკუთვნილი ენდპოინტების კატალოგი კომუნიკაციების REST კონსოლი კომუნიკაციების საჯარო OpenAPI დოკუმენტი OAuth ინტეგრაციის სახელმძღვანელო