API Dokumentation

Ta emot leveransrapporter Om en URL för leveransrapporter har angets när en batch skapas, kommer rapporter över statusuppdateringar att skickas till den URL så fort de finns tillgängliga. Innehållet i dessa rapporter är beskrivna nedan. Systemet skickar ut rapporter genom metoden POST och förväntar sig ett 200 OK i respons om rapporten tagits emot korrekt. Om någon respons består […]

Statuskoder Sammanfattning Detta är en sammanfattning av vad varje statuskodgrupp betyder. Sättet som våra statusblock fungerar är att om till exempel koden börjar med 1 så tillhör statusen statusgruppen Info. Detta gör att vi kan lägga till nya statuskoder samtidigt som din programvara fortfarande kan hantera dessa nya statuskoder utan att vara explicit utvecklad för […]

Verifiera e-postdomäner En registrerad domän måste verifieras innan den används för att säkerställa leverans av e-post och ägande av domänen. Verifiering görs genom att lägga till specifika DNS-poster i domänens namnserver. Kontrollera verifieringsstatus/instruktioner Endpoint: GET domains/{domain}/verification Denna slutpunkt returnerar verifieringsstatusen för domänen. Om verifieringsstatusen är falsk kommer nästa saknade/krävda DNS-poster att tillhandahållas. Respons-datatyp domain Domänen […]

Registrera e-postdomäner för utskick Innan du skickar e-postmeddelanden med våra API:er måste du registrera sändningsdomänen som du ska använda. Du kan registrera hur många domäner du vill och du kan avregistrera de som du inte använder längre. Detta kan du även göra via användarportalen. Dessutom måste registrerade domäner verifieras för att säkerställa leverans av e-postmeddelanden […]

E-postbatcher – En grupp av e-postmeddelanden Läsa en samling av e-postbatcher Endpoint: GET emails Den här endpointen ger dig en samling e-postbatcher för vilka du kan se e-post dokument-definitionen nedan. MessageSummary och PriceSummary kommer dock inte att tillhandahållas eftersom de endast är tillgängliga för den endpointen för enskilda meddelanden i en e-postbatch. Ordnad kronologiskt efter […]

Läs meddelanden När du läser meddelanden är det alltid i ett e-postsammanhang. Ett meddelande kan inte existera utan ett e-post och därför placeras meddelanden under e-postmeddelanden hierarkiskt. Läs en samling av meddelanden Endpoint: GET emails/{email}/messages Denna endpoint kommer att förse dig med dokumenten för alla meddelanden i ett e-postmeddelande med deras senaste leveransrapport som respons-datatypen […]

Skicka e-post Endpoint Endpoint: POST emails När du vill skicka e-postmeddelanden använder du dig av anrops-datatypen nedan. Anrops-datatyp I sin kärna behöver endpointen för e-postustkick följande värden: Detta anrop kommer att omgående att skicka ett e-postmeddelande till varje angiven mottagare med textinnehållet “Detta är ett enkelt testmeddelande” till med avsändaren “iP.1 Networks AB”. senderName Namnet […]

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 […]

Uppdatera underkonto Uppdatera ett enskilt underkonto Endpoint Endpoint: PUT /api/me/children/{child} Denna endpoint låter dig uppdatera ett enskilt underkonto kopplat till ett konto. Anropsadata-typ ID Ett enskilt underkontons unika konto-ID Name Ett enskilt underkontos märkning eller namn. Responsdata-typ Key Ett enskilt underkontots API-nyckel. Parent Ett enskilt underkontos föräldra-konto. Type Ett enskilt underkontos konto-typ. Balance Ett enskilt underkontos […]

Lista underkonton Lista samtliga underkonton Endpoint Endpoint: GET /api/me/children Denna endpoint låter dig lista samtliga underkonton kopplade till ett konto. Lista enskilt underkonto Endpoint Endpoint: GET /api/me/children{child} Denna endpoint låter dig lista ett enskilt underkonto kopplade till ett konto. Responsdata-typ Key Ett enskilt underkontos API-nyckel. Parent Ett enskilt underkontos föräldra-konto. Type Ett enskilt underkontos kontotyp. Balance Ett […]

Skapa underkonto Skapa ett nytt underkonto Endpoint Endpoint: POST /api/me/children Denna endpoint låter dig skapa ett nytt underkonto, underordnat ditt huvudkonto. Anropsdata-typ Name Kontots märkning. Exempelvis avdelningsnamn eller annat namn som anspelar på kontots syfte. Responsdata-typ Key Ett underkontots API-nyckel. Parent Ett underkontos föräldra-konto. Type Ett underkontos konto-typ. Balance Ett underkontos saldonivå. Kan bestå av en […]

Detaljer konto Hämta detaljer för underkonto Endpoint Endpoint: GET /api/me/account Denna endpoint ger dig en detaljlista för ett enskilt konto enligt responsdata-typen nedan. Responsdata-typ Key Ett enskilt kontos API-nyckel. Parent Ett enskilt kontos föräldra-konto. Type Ett enskilt kontos kontotyp. Balance Ett enskilt kontos saldonivå. Kan bestå av en negativ siffra eller positiv siffra beroende på vilken […]

Överblick konton Endpoint Endpoint: GET /api/me Denna endpoint ger dig överblick över ditt huvudkonto konto, Responsdata-typ Account Ett enskilt kontos unika ID bestående av prefixet ip1- följt av ett antal siffror. Organization Företagets/organisations namn som står som ägare till kontot. Type ett enskilt kontos kontotyp, swedish eller international. Konton av typ swedish är enbart lämpat för SMS-trafik inom Sverige. All trafik utanför […]

Hantera sid-element Reading a collection of landing page elements Endpoint: GET v2/landings/{landingId}/elements Denna endpoint ger dig en samling av elementen på en specifik landningssida. Se definitionen av datatyp nedan. Läs ett specifikt element Endpoint: GET v2/landings/{landingId}/elements/{elementId} Denna endpoint ger dig ett specifikt element på en landningssida Uppdatera ett element Endpoint: PUT v2/landings/{landingId}/elements/{elementId} Denna endpoint låter […]

Hantera landningssidor Läs en samling av landningssidor Endpoint: GET v2/landings Denna endpoint ger dig en samling landningssidor för vilka du kan se definitionen av datatypen nedan. Läs en enskild landningssida Endpoint: GET v2/landings/{landingId} Denna endpoint ger dig en enda specifik landningssida. Uppdatera en landningssida Endpoint: PUT v2/landings/{landingId} Denna endpoint kan du uppdatera en specifik landningssida, […]

Sammanfattning kontakter Quick start Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen Anrop Endpoint: v2/contacts/meta Metod: GET Denna endpoint tillhandahåller en summering av den kontaktdata som är lagrad i kontaktsystemet Exempel på anrop Respons Exempel på responsdata Fält för responsdata Fältnamn Typ Beskrivning Exempel totalCount Integer Det […]

Statuskoder Sammanfattning Detta är en sammanfattning av vad varje statuskodgrupp betyder. Sättet som våra statusblock fungerar är att om till exempel koden börjar med 1 så tillhör statusen statusgruppen Info. Detta gör att vi kan lägga till nya statuskoder samtidigt som din programvara fortfarande kan hantera dessa nya statuskoder utan att vara explicit utvecklad för […]

Hantera etiketter Dessa endpoints uppdaterar en samtliga kontakter i perspektivet från en etikett och returnerar en sammanfattning av etiketten i fråga. Lägg till en etikett för flera kontakter Endpoint: POST /v2/labels/{labelName}/contacts Denna endpoint låter dig lägga till en etikett till många kontakter samtidigt. Den tar en samling kontakt-ID:n Exempel-input: Radera en etikett Endpoint: DELETE /v2/labels/{labelName} […]

Hantera kontakter Läs en samling av kontakter Endpoint: GET contacts Denna endpoint ger dig en samling kontakter för vilka du kan se definitionen av kontaktdokumentet nedan. Denna samling kan filtreras efter egenskaper, metadata och/eller etiketter med hjälp av frågeparametrar. Metadata finns bara om meta läggs till som en query-parameter. Exempel på filter Läs en enskild […]

Mass-operationer Dessa endpoints utför så kallade mass-operationer och kan ibland vara destruktivt eller “farligt” då data kan försvinna om den inte används på rätt sätt. Radera kontakter genom filtrering Endpoint: DELETE v2/contacts Denna endpoint låter dig ta bort alla kontakter som matchar de använda filtren. Dessa är samma filter som för att lista kontakter (se […]

Hantera inställningar Varje konto kan ha ett antal inställningar för SMS-tjänster. Dessa kan hanteras med endpoints nedan. Efter endpoints finns en lista över tillgängliga inställningar och deras datatyper. När du ställer in en inställning skapas eller ersätts den antingen beroende på om den har ställts in tidigare. En borttagen inställning återgår antingen till en global […]

Skicka SMS Quick start Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen. Anrop Endpoint: /v2/batches Metod: POST Content-Type: application/json Exempel på anropsdata Exemplet ovan innehåller anropsdatan med de obligatoriska fälten sender, recipients och body, som krävs för att skicka ett SMS-meddelande. Se under rubriken Fält för anropsdata […]

Registrera avsändare Förutsättningar För att du ska kunna använda din egen avsändare behöver du registrera den på ditt konto. Detta kan du göra via anrop till API:et som beskrivs nedan, eller via direkt via användarportalen. Observera att dina registrerade avsändare enbart går att skicka med om du har ett aktivt abonnemang, alternativt extratjänsten “Valfri Avsändare”, […]

Ta emot inkommande SMS Förutsättningar För att kunna ta emot inkommande till vårt system och sedan skicka dem vidare till din callback URL behövs ett virtuellt nummer. Du kan enkelt skaffa ett virtuellt nummer genom att beställa ett av våra abonnemang, eller beställa extratjänsten 11-siffrigt virtuellt nummer i vår webshop. Beskrivning Om en callback URL […]

Ta emot leveransrapporter Beskrivning Om en URL för leveransrapporter har angets när en batch skapas, kommer rapporter över statusuppdateringar att skickas till den URL så fort de finns tillgängliga. Innehållet i dessa rapporter är beskrivna nedan. Systemet skickar ut rapporter genom metoden POST och förväntar sig ett 200 OK i respons om rapporten tagits emot korrekt. Om någon responsen […]

Lista Meddelanden Förutsättningar När du listar meddelanden är det alltid i kontexten av en batch. Ett meddelande kan inte existera utanför en batch, därför är alltid ett meddelande placerat hierarkiskt underordnat en batch. Quick start Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen, samt {batchId} mot ett […]

Konversationer Läs meddelanden till och/eller från en tillhandahållen deltagare. Quick start Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen samt byt ut {participant} mot ett nummer i formatet MSISDN (46712345678) Anrop Hämta alla meddelanden Denna endpoint låter dig hämta samtliga meddelanden i en konversation, oavsett riktning, baserat […]

Hantera Blacklist Ditt konto har en blacklist med telefonnummer som på något sätt har blockerats från att ta emot SMS. Detta kan göras genom att använda dessa API:er eller genom att mottagaren svarar med ‘STOP’ eller använder extratjänsten “avregistreringslänk”. Responsdata-typ msisdn Det blockerade mobilnumret i MSISDN format. created En tidsstämpel för när numret lades till […]

Batcher Quick start Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen. Anrop Lista en samling av batcher Endpoint: /v2/batches Metod: GET Lista en enskild Batch Endpoint: /v2/batches/{batchId} Metod: GET Exempel på anrop Fält för anropsdata Fältnamn Typ Beskrivning Exempel batchId String Batchens ID. 5bc86b6e85c7209830f96936 Respons Exempel på […]

Introduktion RESTful API:er från iP.1 Kom igång Vårt SMS 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 SMS-trafik och lämpar sig perfekt för bland annat större grupputskick vid exempelvis marknadsföring, men även singelutskick för automatiserade SMS-larm etc. Skapa ett konto För […]

API:er från iP.1 Vi på iP.1 tycker att det ska vara enkelt att utveckla och har fullständig dokumentation över samtliga våra API:er. Välj ovan vilket API du vill implementera genom att klicka på respektive ruta. Upptäck möjligheterna med våra API:er Genom att ladda ner vår demo-app kan du gå en rundtur i våra API:er för […]