Kom igång #

Vårt RCS API låter dig koppla upp dina webbtjänster och applikationer mot mobiloperatörer världen över och är designat för att hantera höga volymer av RCS-trafik och lämpar sig perfekt för bland annat större konversationer, chat botar, OTP och marknadsföring med Rich Content och produktkaruseller.


Skapa ett konto #

För att komma igång behöver du först och främst ett konto, vilket du kan skapa här.

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.ip1.net/v3/

Alla requester måste göras genom HTTPS.

Systemet har en gräns på 30 requester/sek per konto.


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.

  1. Gå till ”Konton”.
  2. Gå till ”Behörigheter”
  3. Gå till ”API-nycklar”
  4. Klicka på ”Lägg till ny nyckel”,
  5. Ange ett namn och eventuella IP-begränsningar
  6. Klicka på ”Lägg till”.

Paginering #

Alla endpoints under /v3/ som returnerar en samling av dokument (Conversations, meddelanden etc.) har paginering aktiverat. Vi använder oss av databas-stilen av paginering med start, limit och order som parameternamn.startlimit 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

Länk-huvud #

Du kommer också ta emot ett länk-huvud som innehåller paginerings-information.

📋
Länkhuvud
Kopiera till urklipp
Link: <https://api.ip1.net/v2/conversations?start=201&limit=100&order=ASC>; rel="next",
      <https://api.ip1.net.comv2/conversations?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.