REST API-dokumentation
REST API'er til konto og fakturering
Læs saldoen og de faktureringsoplysninger, der er tilgængelige for din godkendte integration.
Vælg API og legitimation sammen
Godkendte konti med profilerne Udvikler og automatisering, Erhverv og Kommunikationsudbydere kan integrere aktiverede tjenester. En individuel udvikler behøver ikke give sig ud for at være en virksomhed. SMS/MMS fra applikationer kræver den relevante afsendelsesgodkendelse og registrering. Tjenesten for Privatpersoner og familier har ingen API tilgængelig for kunder til afsendelse af beskeder.
| API-familie | Basis-URL | Autentificering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkendt Basic-legitimation; kvalificerede tildelte tokens kun til handlinger, der understøtter dem. JSON status og response. |
| Nødopkaldsregistrering | https://api.multi.tel/emergency | Godkendt Basic-legitimation eller specifikt tildelt bearer-adgang. JSON code, message og data. |
| Portal-REST-integrationer | Vært og handling vist i din kontos udviklerreference | Brug den pågældende handlings dokumenterede legitimation, scopes og skema. Anmodninger fra browsersessioner bruger en separat grænseflade. |
Angiv MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via din servers konfiguration af hemmeligheder, før du bruger eksemplerne. Indlejr dem aldrig i offentlig JavaScript i browseren, i URL’er eller i kildekodestyring. Dedikerede legitimationsoplysninger administreres i indstillinger for API-integration.
Første anmodning: aflæs din saldo
Denne læsning køber ikke en tjeneste og starter hverken et opkald eller en meddelelse.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Communications v3 API’et returnerer et applikationsresultat i JSON-indholdet. Kontrollér HTTP-status og status.code, før du læser response; en afvist anmodning har muligvis intet svarobjekt. Kodeværdier kan være strenge eller tal.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Dette er et fiktivt eksempel og ikke en kontosaldo. Behandl pengebeløb som decimaltal. Gem serverens svarbesked, når du fejlfinder en afvist anmodning, men fjern legitimationsoplysningerne.
Brug faktureringsdata korrekt
Saldosvaret indeholder den aktuelle saldo, valuta og betalingsbetingelser. Det angiver ikke prisen for et fremtidigt opkald eller en komplet faktura. Brug de tilsvarende handlinger for takster og forbrug til de spørgsmål. Eksisterende numre kan have andre abonnementer end dagens katalog.
Håndtering af fejl og nye forsøg
- Fejl i autentificering eller tilladelser
- Kontrollér, om API-legitimationen er aktiveret, hvilken tjeneste den har tilladelse til, og hvilke begrænsninger der gælder for kilde-IP. En portalsessions-cookie er ikke en integrationslegitimation.
- Utilstrækkelig saldo eller manglende godkendelse
- Løs problemet med kontosaldoen, afsendelsesgodkendelsen eller dokumentkravet, før du gentager handlingen.
- Intet resultat
- Behandl et tomt lager eller et manglende opkaldsnavn som et almindeligt udfald. Antag ikke, at et syntaktisk gyldigt nummer har alle tjenester.
- Netværkstimeout eller tjenestefejl
- Brug begrænsede nye forsøg med backoff ved læsninger. Ved et køb, en afsendelse eller en registrering skal du først kontrollere handlingens tilstand; et nyt forsøg på en accepteret anmodning kan duplikere en handling, der medfører betaling.
Understøttelse af idempotens gælder for den enkelte API-familie. Emergency API’et understøtter nøgler til nye forsøg; det gør ikke vilkårlige v3-anmodninger idempotente. Gem tidsstempler, returnerede ID’er og svar, hvor følsomme oplysninger er fjernet, til support.
Fortsæt med din kontos reference
Den indloggede reference filtrerer operationer efter dine rettigheder og aktiverede tjenester. Brug dens præcise host, legitimationstype, forespørgselsfelter og svarskema. Konsollerne kan udføre live-operationer, herunder køb og beskeder.