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

LRN მარშრუტიზაციის მოძიების 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 ინტეგრაციის პარამეტრებში იმართება.

ნომრის მოძიება

GET /v3/lrn/{number} დანიშნულების ნომერს URL-ის გზაში იღებს. გამომძახებლის ნომერზე დამოკიდებული ინფორმაციისთვის ეს ნომერი სურვილისამებრ შეგიძლიათ /v3/lrn/{number}/{ani} ფორმით მიუთითოთ. გამოიყენეთ ჩრდილოეთ ამერიკის ნომერი მხოლოდ ციფრებით და, საჭიროების შემთხვევაში, ქვეყნის კოდით; მაგალითებში რეზერვირებული გამოგონილი ნომრებია.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123"

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123/12025550124"

მოქმედი ავტორიზაციის მონაცემებით მოძიების შესრულება ფასიანია. ტარიფია 0,00025 US$ თითო მოძიებაზე: 0,25 US$ ყოველ 1000-ზე ან 250 US$ მილიონზე. მოცულობაზე დამოკიდებული ფასდაკლებები არ არსებობს. ეს მარშრუტიზაციის ინფორმაციის მოძიებაა და სატელეფონო ზარს არ ახორციელებს.

შედეგის წაკითხვა

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": {
    "lrn": "12025550123",
    "ported": 0,
    "ocn": "",
    "lata": "",
    "rc": "",
    "cost": "$0.00025"
  }
}

ეს გამოგონილი მაგალითი მხოლოდ პასუხის ფორმას აჩვენებს; ის არ არის გაზომილი მარშრუტიზაციის შედეგი. შეამოწმეთ status.code response-ის გამოყენებამდე. cost ველი არის ვალუტის პრეფიქსით აღნიშნული სტრიქონი და არა JSON რიცხვი.

ველი	მნიშვნელობა
`lrn`	მარშრუტიზაციის ნომერი (Location Routing Number), რომელიც დანიშნულების მარშრუტის დასადგენად გამოიყენება.
`ported`	ამ მოძიებით მოწოდებული ნომრის პორტირების მაჩვენებელი: ჩვეულებრივ 0 ან 1. ნუ გამოიყენებთ მას საკუთრების ან სერვისით სარგებლობის უფლების დასტურად.
`ocn`	ოპერატორი კომპანიის ნომერი (Operating Company Number), თუ მოწოდებულია.
`lata`	ადგილობრივი წვდომისა და გადაცემის არეალი (Local Access and Transport Area), თუ მოწოდებულია.
`rc`	სატარიფო ცენტრი, თუ მოწოდებულია.
`city`, `state`, `lec`, `lectype`, `jurisdiction`, `local`	დამატებითი ადგილმდებარეობის, ოპერატორის ან წარმოშობასთან დაკავშირებული დეტალები, როდესაც ხელმისაწვდომია. ისინი შეიძლება არ იყოს ან ცარიელი იყოს.

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

მოძიებების გამოყენება თქვენს მარშრუტიზაციის სამუშაო პროცესში

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

იხილეთ LRN პროდუქტი და მისი ერთიანი ტარიფი. საჯარო OpenAPI გზა ANI სეგმენტს შეიცავს; მოქმედი LRN რეალიზაცია მოკლე მოთხოვნასაც იღებს ANI-ის გარეშე. lrninfo ცალკე ოპერაციაა და ამ ენდპოინტის ნაცვლად არ უნდა გამოიყენოთ.

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

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

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

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

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

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