{"id":3887,"date":"2024-11-15T13:08:51","date_gmt":"2024-11-15T13:08:51","guid":{"rendered":"http:\/\/34.88.191.99\/?page_id=3887"},"modified":"2025-04-07T13:59:42","modified_gmt":"2025-04-07T13:59:42","slug":"introduction-email-api","status":"publish","type":"page","link":"https:\/\/ip1sms.com\/en\/developer\/introduction-email-api\/","title":{"rendered":"Introduction email API"},"content":{"rendered":"<h1 class=\"wp-block-heading\" id=\"introduction-to-the-tabellae-api\">Introduction to the iP.1 e-mail API<\/h1>\n\n\n\n<p>The iP.1 e-mail API allows you to connect your websites and applications to e-mail clients worldwide.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"getting-started\">Getting started<\/h2>\n\n\n\n<p>To use our APIs, you first need to register an account. You can do this by visiting our webshop. <a href=\"https:\/\/shop.ip1.net\/account\/new\" target=\"_blank\" rel=\"noopener\">Register a free trial account<\/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<h2 class=\"wp-block-heading\" id=\"api-endpoint\">API Endpoint<\/h2>\n\n\n\n<p>The base URL for all our endpints in our RESTful API is the following:<strong>&nbsp;https:\/\/api.ip1sms.com\/v2\/<\/strong><\/p>\n\n\n\n<p>All requests must be made using HTTPS.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"authentication\">Authentication<\/h2>\n\n\n\n<p>All endpoints are protected by authentication using\u00a0<em>HTTP Bearer<\/em>\u00a0tokens 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\u00a0<a href=\"https:\/\/portal.ip1.net\/\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">User Portal<\/a><\/p>\n\n\n\n<p>Sign in to\u00a0<a href=\"https:\/\/portal.ip1.net\/\" rel=\"nofollow noopener\" target=\"_blank\">the user portal<\/a>\u00a0with 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=\"https:\/\/ip1sweden.blob.core.windows.net\/blobip1websitef76b7023b5\/wp-content\/uploads\/2024\/03\/ip1-portal-create-key.webm\"><\/video><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"pagination\">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\" id=\"link-header\">Link Header<\/h3>\n\n\n\n<p>You&#039;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\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 the following<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Name<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>self<\/td><td>The link relation for the requested page of results.<\/td><\/tr><tr><td>first<\/td><td>The link relation for the first page of results.<\/td><\/tr><tr><td>prev<\/td><td>The link relation for the immediate previous page of results.<\/td><\/tr><tr><td>next<\/td><td>The link relation for the immediate next page of results.<\/td><\/tr><tr><td>last<\/td><td>The link relation for the last page of results.<\/td><\/tr><\/tbody><\/table><\/figure>","protected":false},"excerpt":{"rendered":"<p>Introduktion till iP.1 e-mail API iP.1 e-mail API l\u00e5ter dig ansluta dina webbplatser och applikationer till e-postklienter \u00f6ver hela v\u00e4rlden. Kom ig\u00e5ng F\u00f6r att anv\u00e4nda v\u00e5ra API:er beh\u00f6ver du f\u00f6rst registrera ett konto. Detta kan du g\u00f6ra genom att bes\u00f6ka v\u00e5r webshop. Registrera ett kostnadsfritt testkonto. N\u00e4r du skapat ditt konto loggar du in i [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":382,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"developer-email.php","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-3887","page","type-page","status-publish","hentry","category-api-dokumention"],"_links":{"self":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/3887","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=3887"}],"version-history":[{"count":0,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/3887\/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=3887"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/categories?post=3887"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/tags?post=3887"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}