Introduktion till iP.1 Survey API

iP.1’s API tillåter dina webbplatser och applikationer att skapa dynamiska undersökningar och leverera dem via SMS, e-post eller statiska länkar.

Komma igång

För att använda iP.1’s API behöver du registrera dig i vår Web App för att konfigurera ditt konto.

Efter att ha skapat ett konto, logga in på vår användarportal för att få tillgång till dina autentiseringsuppgifter som förklaras under rubriken Autentisering som du hittar nedan.

API Endpoint

Bas-URL:en för alla våra endpoints är följande. https://api.ip1sms.com/v2/

Alla förfrågningar måste göras med HTTPS.

Autentisering

Alla endpoints är skyddade av autentisering med HTTP Bearer-tokens som tillhandahålls av oss. Varje konto kan ha flera API-tokens med olika begränsningar för tillåtna IP-adresser etc. Dessa kan nås, skapas och redigeras i användarportalen

Pagination

Alla endpoints som returnerar en samling dokument (undersökningar, frågor etc.) har pagination aktiverad. Vi använder databasstilen av pagination med start, limit och order som dess parameternamn eller offset, limit och order by som de kallas i MariaDB. Som standard är start, limit och order inställda på 0, 50 and ASC respektive, men du kan ändra dem efter eget tycke genom att lägga till dem som frågeparametrar när du gör din HTTP-förfrågan så här: ?start=0&limit=200&order=DESC

Link Header

Du kommer också att få en Link header som innehåller pagination information.

Link: <https://api.ip1sms.com/v2/surveys?start=201&limit=100&order=ASC>; rel="next",
      <https://api.ip1sms.com/v2/surveys?start=4901&limit=100&order=ASC>; rel="last"

Det här exemplet innehåller en radbrytning för läsbarhet.

Möjliga rel värden är: