Dokumentacja REST API
API REST konta i rozliczeń
Odczytuj saldo i informacje rozliczeniowe dostępne dla Twojej zatwierdzonej integracji.
Wybierz API i poświadczenie razem
Zatwierdzone konta dla programistów i automatyzacji, firm oraz dostawców usług komunikacyjnych mogą integrować włączone usługi. Indywidualny programista nie musi udawać firmy. SMS/MMS wysyłane przez aplikacje wymagają odpowiedniej zgody na wysyłkę i rejestracji. Usługa dla osób prywatnych i rodzin nie udostępnia klientom API do inicjowania wysyłki wiadomości.
| Rodzina API | Bazowy adres URL | Uwierzytelnianie i wynik |
|---|---|---|
| Komunikacja v3 | https://api.multitel.net/v3 | Zatwierdzone poświadczenia Basic; kwalifikujące się udostępnione tokeny tylko dla operacji, które je obsługują. JSON status i response. |
| Rejestracja numerów alarmowych | https://api.multi.tel/emergency | Zatwierdzone poświadczenia Basic lub specjalnie udostępniony dostęp bearer. JSON code, message i data. |
| Integracje REST portalu | Host i operacja wskazane w dokumentacji dla programistów Twojego konta | Używaj danych uwierzytelniających, zakresów uprawnień i schematu opisanych dla danej operacji. Żądania sesji przeglądarki stanowią odrębny kanał dostępu. |
Przed użyciem przykładów ustaw MULTITEL_API_USERNAME i MULTITEL_API_PASSWORD w konfiguracji sekretów swojego serwera. Nigdy nie umieszczaj ich w publicznym JavaScripcie przeglądarki, adresach URL ani w repozytorium kodu. Dedykowanymi poświadczeniami zarządzasz w ustawieniach integracji API.
Pierwsze żądanie: odczytaj saldo
Ten odczyt nie kupuje usługi ani nie inicjuje połączenia lub wiadomości.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API komunikacyjne v3 zwraca wynik aplikacji w treści JSON. Przed odczytaniem response sprawdź status HTTP oraz status.code; odrzucone żądanie może nie zawierać obiektu odpowiedzi. Wartości kodów mogą być ciągami znaków lub liczbami.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}To jest fikcyjny przykład, a nie saldo konta. Traktuj wartości pieniężne jako kwoty dziesiętne. Podczas diagnozowania odrzuconego żądania zachowaj komunikat odpowiedzi serwera, usuwając z niego dane uwierzytelniające.
Prawidłowe korzystanie z danych rozliczeniowych
Odpowiedź z saldem zawiera bieżące saldo, walutę i warunki płatności. Nie podaje kosztu przyszłego połączenia ani kompletnej faktury. W tych kwestiach użyj odpowiednich operacji stawek i zużycia. Istniejące numery mogą mieć inne plany niż obecny katalog.
Obsługa błędów i ponowień
- Błąd uwierzytelniania lub uprawnień
- Sprawdź, czy poświadczenie API jest włączone, jaka usługa jest dozwolona oraz jakie obowiązuje ograniczenie źródłowego adresu IP. Plik cookie sesji portalu nie jest poświadczeniem integracji.
- Niewystarczające środki lub brak wymaganej zgody
- Uzupełnij środki na koncie, uzyskaj zgodę na wysyłkę lub dostarcz wymagany dokument, zanim powtórzysz operację.
- Brak wyniku
- Puste zasoby numerów lub brak nazwy dzwoniącego traktuj jako zwykły wynik. Nie zakładaj, że poprawny składniowo numer obsługuje każdą usługę.
- Przekroczenie czasu sieci lub awaria usługi
- Dla operacji odczytu stosuj ograniczoną liczbę ponowień z rosnącymi odstępami między próbami. Przy zakupie, wysyłce lub rejestracji najpierw sprawdź stan operacji; ponowienie przyjętego żądania może powielić płatną czynność.
Obsługa idempotentności zależy od danej rodziny API. połączeń alarmowych API obsługuje klucze ponowień, ale to nie czyni dowolnych żądań v3 idempotentnymi. Zachowaj znaczniki czasu, zwrócone identyfikatory i odpowiedzi z usuniętymi danymi wrażliwymi na potrzeby pomocy technicznej.
Przejdź do dokumentacji swojego konta
Dokumentacja dostępna po zalogowaniu filtruje operacje według Twoich uprawnień i włączonych usług. Korzystaj z jej dokładnego hosta, typu poświadczeń, pól żądania i schematu odpowiedzi. Konsole mogą wykonywać operacje na żywo, w tym zakupy i wysyłanie wiadomości.