Introduktion
Bas-URL, autentisering, begränsningar och paginering för iP.1 SMS API.
iP.1 SMS API är ett REST-baserat API för enskilda, automatiserade och stora SMS-utskick. API:et använder JSON och samtliga anrop måste göras över HTTPS.
Bas-URL
https://api.ip1sms.com/v2/Om inget annat anges visar endpoint-tabellerna sökvägen under /v2. POST /batches betyder alltså POST https://api.ip1sms.com/v2/batches.
Några äldre, fortfarande operativa endpoints använder en annan URL-struktur utan /v2. Det framgår på respektive sida. Konto- och underkontoendpointsen använder exempelvis /api/... och beskrivs i Konto och underkonton.
Skapa konto och API-nyckel
- Skapa ett konto.
- Logga in i användarportalen.
- Skapa en API-nyckel för kontot.
- Begränsa nyckeln till de IP-adresser och rättigheter som integrationen behöver.
Lagra aldrig nyckeln i klientkod, versionshantering eller offentliga loggar. Använd en hemlighetshanterare eller skyddad miljövariabel och rotera nyckeln om den kan ha röjts.
Autentisering
Alla endpoints skyddas med HTTP Bearer-autentisering:
Authorization: Bearer DIN_API_NYCKEL
Content-Type: application/jsonExempel:
curl "https://api.ip1sms.com/v2/batches" \
-H "Authorization: Bearer $IP1_TOKEN" \
-H "Accept: application/json"En saknad eller ogiltig token ger normalt 401 Unauthorized. En giltig token utan rätt behörighet kan ge 403 Forbidden.
Anropsgräns
Den publicerade gränsen är 30 anrop per sekund och konto. Utforma klienten med kö, begränsad parallellitet och exponentiell backoff. Automatiska omförsök ska bara göras när operationen är säker att upprepa.
Paginering
Endpoints under /v2/ som returnerar samlingar använder:
| Parameter | Standard | Beskrivning |
|---|---|---|
start |
0 |
Startposition i samlingen. |
limit |
50 |
Maximalt antal dokument i svaret. |
order |
ASC |
Sorteringsordning, ASC eller DESC. |
GET /v2/batches?start=0&limit=200&order=DESCSvaret innehåller ett Link-header med relevanta relationer:
Link: <https://api.ip1sms.com/v2/batches?start=200&limit=100&order=ASC>; rel="next",
<https://api.ip1sms.com/v2/batches?start=4900&limit=100&order=ASC>; rel="last"Möjliga relationer är self, first, prev, next och last. Följ länkarna från servern i stället för att själv räkna fram nästa sida.