Introduktion till iP.1 e-mail API
iP.1 e-mail API låter dig ansluta dina webbplatser och applikationer till e-postklienter över hela världen.
Kom igång
För att använda våra API:er behöver du först registrera ett konto. Detta kan du göra genom att besöka vår webshop. Registrera ett kostnadsfritt testkonto.
När du skapat ditt konto loggar du in i vår användarportal för att få tillgång till dina autentiseringsuppgifter, som beskrivs närmare i steget nedan.
API Endpoint
Bas-url:en för endpoints enligt API-referens i vårt RESTful API är: https://api.ip1sms.com/v2/
Alla requester måste göras genom HTTPS.
Autentisering
Alla våra API endpoints är skyddade av autentisering via HTTP Bearer tokens, som vi tillhandahåller. Varje konto du skapar kan ha flera nycklar med olika restriktioner på tillåtna IP-adresser som du själv anger. API-nycklarna hanterar du i vår Användarportal.
Logga in i användarportalen med din iP.1-användare som skapades i samband med din kontoregistrering. Följ sedan video-instruktionen nedan för att skapa din nyckel.
Paginering
Alla endpoints under /v2/ som returnerar en samling av dokument (Batcher, meddelanden etc.) har paginering aktiverat. Vi använder oss av databas-stilen av paginering med start, limit och order som parameternamn. start, limit och order är sätt till 0, 50 och ASC i respektive ordning, men du kan ändra dem genom att ange dem som query-parametrar när du gör ett HTTP-anrop på detta vis:
?start=0&limit=200&order=DESC
Link Header
You’ll also receive a Link header which includes pagination information.
Link: <https://api.ip1sms.com/v2/emails?start=201&limit=100&order=ASC>; rel="next",
<https://api.ip1sms.com/v2/emails?start=4901&limit=100&order=ASC>; rel="last"
Detta exempel innehåller radbryt för läsbarhetens skull.
Möjliga värden för rel är följande
Namn | Beskrivning |
---|---|
self | Länkrelationen för den begärda resultatsidan. |
first | Länkrelationen för den första resultatsidan. |
prev | Länkrelationen för den omedelbart föregående resultatsidan. |
next | Länkrelationen för den omedelbart nästa resultatsidan. |
last | Länkrelationen för den sista resultatsidan. |