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.multitel.net/v3/getbalance"

კომუნიკაციების v3 API ოპერაციის შედეგს JSON პასუხის ტანში აბრუნებს. response-ის წაკითხვამდე შეამოწმეთ HTTP სტატუსი და status.code; უარყოფილი მოთხოვნის პასუხში response ობიექტი შეიძლება არ იყოს. კოდის მნიშვნელობები შეიძლება სტრიქონები ან რიცხვები იყოს.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "25.0000",
    "currency": "USD",
    "terms": "Prepaid"
  }
}

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

საბილინგო მონაცემების სწორად გამოყენება

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

კომუნიკაციების API კონვენციები ანგარიშის სპეციფიკური საბილინგო სქემები

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

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

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

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

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

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