{"id":412,"date":"2023-11-23T11:13:41","date_gmt":"2023-11-23T10:13:41","guid":{"rendered":"http:\/\/localhost\/wordpress\/?page_id=412"},"modified":"2026-01-08T12:20:11","modified_gmt":"2026-01-08T12:20:11","slug":"introduction","status":"publish","type":"page","link":"https:\/\/ip1sms.com\/en\/developer\/introduction\/","title":{"rendered":"Introduction"},"content":{"rendered":"<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column p-5 is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:85%\">\n<h1 class=\"wp-block-heading\" id=\"h-introduktion-restful-api-er-fran-ip-1\">Introduction RESTful API\u00b4s from iP.1<\/h1>\n\n\n\n<h2 class=\"wp-block-heading my-5\" id=\"h-kom-igang\">Getting started<\/h2>\n\n\n\n<p>Our SMS API allows you to connect your web services and applications to mobile operators around the world and is designed to handle high volumes of SMS traffic. This API is optimal for larger group sendings such as marketing, but also single sendings for automated SMS alarms etc.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity p-5\"\/>\n\n\n\n<h2 class=\"wp-block-heading my-5\" id=\"h-skapa-ett-konto\">Create account<\/h2>\n\n\n\n<p>To get started you will need an account, which you can&nbsp;<a href=\"https:\/\/ip1sms.com\/en\/trial-account\/\">create here<\/a><a href=\"https:\/\/shop.ip1.net\/account\/new\" target=\"_blank\" rel=\"noopener\">.<\/a><\/p>\n\n\n\n<p>Once you have created your account, log in to our user portal to access your credentials, which are described in more detail in the step below.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity my-5\"\/>\n\n\n\n<h2 class=\"wp-block-heading my-5\" id=\"h-api-endpoint\">API Endpoint<\/h2>\n\n\n\n<p>The base URL for all our endpints in our RESTful API is the following:&nbsp;<strong>https:\/\/api.ip1sms.com<\/strong><\/p>\n\n\n\n<p>All requests must be made using HTTPS.<\/p>\n\n\n\n<p>The system has a rate limit of 30 request\/sek per account<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity my-5\"\/>\n\n\n\n<h2 class=\"wp-block-heading my-5\" id=\"h-autentisering\">Authentication<\/h2>\n\n\n\n<p>All endpoints are protected by authentication using&nbsp;<em>HTTP Bearer<\/em>&nbsp;tokens provided by us. Any account may have several API tokens with different restrictions on allowed IP-addresses etc. These can be accessed, created and edited in our&nbsp;<a href=\"https:\/\/portal.ip1.net\/\" target=\"_blank\" rel=\"noreferrer noopener\">User Portal<\/a><\/p>\n\n\n\n<p>Sign in to&nbsp;<a href=\"https:\/\/portal.ip1.net\/\" target=\"_blank\" rel=\"noopener\">the user portal<\/a>&nbsp;with your iP.1 User that was created when you registered your account. Watch the instruction video below in order to create your API key.<\/p>\n\n\n\n<figure class=\"wp-block-video\"><video height=\"720\" style=\"aspect-ratio: 1280 \/ 720;\" width=\"1280\" controls src=\"\/wp-content\/uploads\/2024\/03\/ip1-portal-create-key.webm\"><\/video><\/figure>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity my-5\"\/>\n\n\n\n<h2 class=\"wp-block-heading my-5\" id=\"h-paginering\">Pagination<\/h2>\n\n\n\n<p>All endpoints in&nbsp;<em>\/v2\/<\/em>&nbsp;which return a collection of documents (batches, messages etc.) have pagination turned on. We use the database style of pagination with&nbsp;<em>start<\/em>,&nbsp;<em>limit&nbsp;<\/em>and&nbsp;<em>order&nbsp;<\/em>as it's parameter names.&nbsp;<em>start<\/em>,&nbsp;<em>limit&nbsp;<\/em>and&nbsp;<em>order&nbsp;<\/em>are set to&nbsp;<em>0<\/em>,&nbsp;<em>50<\/em>&nbsp;and&nbsp;<em>ASC&nbsp;<\/em>respectively but you may change them to your liking by adding them as query parameters when making your HTTP request like this<\/p>\n\n\n\n<p><em>?start=0&amp;limit=200&amp;order=DESC<\/em><\/p>\n\n\n\n<h3 class=\"wp-block-heading my-5\" id=\"h-lank-huvud\">Link header<\/h3>\n\n\n\n<p>You'll also receive a Link header which includes pagination information.<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code\"><pre class=\"brush: csharp; title: ; notranslate\" title=\"\">\nLink: ; rel=&quot;next&quot;, ; rel=&quot;load&quot;\n<\/pre><\/div>\n\n\n<p>This example includes a line break for readability.<\/p>\n\n\n\n<p>Possible values for&nbsp;<em>rel&nbsp;<\/em>is:<\/p>\n\n\n\n<div class=\"responsive-table\">\n  <table class=\"table table-dark table-striped developer-table\">\n    <thead>\n      <tr>\n        <th>Name<\/th>\n        <th>Description<\/th>\n      <\/tr>\n    <\/thead>\n    <tbody>\n      <tr>\n        <td><strong>self<\/strong><\/td>\n        <td>The link relation for the requested page of results.<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>first<\/strong><\/td>\n        <td>The link relation for the first page of results.<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>prev<\/strong><\/td>\n        <td>The link relation for the immediately preceding result page<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>next<\/strong><\/td>\n        <td>The link relation for the immediate next page of results.<\/td>\n      <\/tr>\n      <tr>\n        <td><strong>last<\/strong><\/td>\n        <td>The link relation for the last page of results.<\/td>\n      <\/tr>\n    <\/tbody>\n  <\/table>\n<\/div>\n\n\n\n<script type=\"application\/ld+json\">{\n    \"@context\": \"https:\\\/\\\/schema.org\",\n    \"@type\": \"Service\",\n    \"name\": \"iP.1 SMS API Dokumentation\",\n    \"description\": \"introduktion till iP.1:s REST API f\\u00f6r programmatisk SMS-kommunikation och utvecklarguider.\",\n    \"url\": \"https:\\\/\\\/ip1sms.com\\\/utvecklare\\\/introduktion\\\/\",\n    \"provider\": {\n        \"@type\": \"Organization\",\n        \"name\": \"iP.1 Networks AB\",\n        \"url\": \"https:\\\/\\\/ip1sms.com\\\/\"\n    },\n    \"isRelatedTo\": {\n        \"@type\": \"Service\",\n        \"name\": \"SMS-tj\\u00e4nster\",\n        \"url\": \"https:\\\/\\\/shop.ip1.net\\\/products\\\/sms-services\"\n    }\n}<\/script>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:15%\"><\/div>\n<\/div>","protected":false},"excerpt":{"rendered":"<p>Introduktion RESTful API:er fr\u00e5n iP.1 Kom ig\u00e5ng V\u00e5rt SMS API l\u00e5ter dig koppla upp dina webbtj\u00e4nster och applikationer mot mobiloperat\u00f6rer v\u00e4rlden \u00f6ver och \u00e4r designat f\u00f6r att hantera h\u00f6ga volymer av SMS-trafik och l\u00e4mpar sig perfekt f\u00f6r bland annat st\u00f6rre grupputskick vid exempelvis marknadsf\u00f6ring, men \u00e4ven singelutskick f\u00f6r automatiserade SMS-larm etc. Skapa ett konto F\u00f6r [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":382,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"developer.php","meta":{"footnotes":""},"categories":[4],"tags":[23,26],"class_list":["post-412","page","type-page","status-publish","hentry","category-api-dokumention","tag-introduktion","tag-sms"],"_links":{"self":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/412","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/comments?post=412"}],"version-history":[{"count":0,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/412\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/382"}],"wp:attachment":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/media?parent=412"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/categories?post=412"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/tags?post=412"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}