{"id":16727,"date":"2017-12-21T09:26:42","date_gmt":"2017-12-21T13:26:42","guid":{"rendered":"https:\/\/www.spreadshop.com\/blog\/?p=16727"},"modified":"2025-08-05T13:27:19","modified_gmt":"2025-08-05T17:27:19","slug":"changes-api-usage","status":"publish","type":"post","link":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/","title":{"rendered":"Changes to API Usage"},"content":{"rendered":"<p>For those of you making use of the Public API, there\u2019ll be a few important changes coming first thing in 2018. This article will tell you everything you need to know.<\/p>\n<p><!--more--><\/p>\n<p>Here\u2019s a quick overview of what\u2019s happening: at the beginning of the year 2018. All applications using our API need to \u2026<\/p>\n<ul>\n<li>be run through HTTPS<\/li>\n<li>use the official domains api.spreadshirt.com (North-American platforms) and api.spreadshirt.net (EU platforms)<\/li>\n<li>transmit a valid API key<\/li>\n<li>provide a user agent<\/li>\n<\/ul>\n<h2>HTTPS<\/h2>\n<p>It\u2019s for the sake of safety. All API requests need to go through HTTPS in future. HTTP requests will then be redirected to HTTPS.<\/p>\n<h2>Official Domains<\/h2>\n<p>All requests will need to go through our official domains api.spreadshirt.net and api.spreadshirt.com \u2013 all other channels for using the API will be closed. As a safety precaution, we may also block access of unofficial routes.<\/p>\n<h2>API Key<\/h2>\n<p>All applications issuing API requests need to transmit a valid API-Key.\u00a0The easiest was to do this is by adding a query parameter along with the API key to each URL. An example:<\/p>\n<p>https:\/\/api.spreadshirt.net\/api\/v1\/shops\/205909?apiKey=8e5bb312-9060-446f-ada2-8c319327745a<\/p>\n<p>This option will still be supported, but it\u2019s not a recommendation.<\/p>\n<p>Better still is using the authorization header in place <a href=\"https:\/\/developer.spreadshirt.net\/display\/API\/Security\">here<\/a><\/p>\n<p>Communication through HTTPS will also transmit the header encrypted.<\/p>\n<p>API keys for European and North-American platforms are available here:<\/p>\n<ul>\n<li>https:\/\/www.spreadshirt.de\/-C7120<\/li>\n<li>https:\/\/www.spreadshirt.com\/-C6840<\/li>\n<\/ul>\n<h2>User Agent<\/h2>\n<p>All browser applications need to transmit an additional user agent in future, so that the API user can be identified. The user agent needs to look like this:<\/p>\n<p>User agent: &lt;YourApplication&gt;\/&lt;YourAppVersion&gt; (https:\/\/www.yourdomain.com; yourname@yourdomain.com)<\/p>\n<p>This is an example of a user agent:<\/p>\n<p>User agent: WordPress-Plugin\/1.0 (https:\/\/www.deinblog.com; admin@deinblog.com)<\/p>\n<p>If you use our API, please provide us with a) the name of the application, b) the version of the application, and c) the administrators email address. This is important so we can get in touch when it should it be necessary.<\/p>\n<p><em>We hope that you\u2019re just as happy with the changes as we are. Please refer any <\/em><em>questions and feedback<\/em><em> you have with us. <\/em><\/p>\n","protected":false},"excerpt":{"rendered":"<p>For those of you making use of the Public API, there\u2019ll be a few important changes coming first thing in 2018. This article will tell you everything you need to know. <a href=\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\">Read more<\/a><\/p>\n","protected":false},"author":674,"featured_media":16764,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"image","meta":{"publish_to_discourse":"0","publish_post_category":"","wpdc_auto_publish_overridden":"","wpdc_topic_tags":"","wpdc_pin_topic":"","wpdc_pin_until":"","discourse_post_id":"","discourse_permalink":"","wpdc_publishing_response":"","wpdc_publishing_error":"","_cloudinary_featured_overwrite":false},"categories":[49172],"tags":[30577],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v19.3 (Yoast SEO v19.7.1) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Changes to API Usage - The Spreadshop Blog<\/title>\n<meta name=\"description\" content=\"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Changes to API Usage\" \/>\n<meta property=\"og:description\" content=\"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\" \/>\n<meta property=\"og:site_name\" content=\"The Spreadshop Blog\" \/>\n<meta property=\"article:published_time\" content=\"2017-12-21T13:26:42+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-08-05T17:27:19+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/images.spreadshop.com\/images\/f_auto,q_auto\/v1513860471\/blog\/Article\/General\/MDS-637-BP-API-changes\/MDS-637-BP-API-changes.png?_i=AA\" \/>\n\t<meta property=\"og:image:width\" content=\"1400\" \/>\n\t<meta property=\"og:image:height\" content=\"800\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Lena\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Lena\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\",\"url\":\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\",\"name\":\"Changes to API Usage - The Spreadshop Blog\",\"isPartOf\":{\"@id\":\"https:\/\/www.spreadshop.com\/blog\/#website\"},\"datePublished\":\"2017-12-21T13:26:42+00:00\",\"dateModified\":\"2025-08-05T17:27:19+00:00\",\"author\":{\"@id\":\"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/678cee42723a944607e63a9022f5f176\"},\"description\":\"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!\",\"breadcrumb\":{\"@id\":\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.spreadshop.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Changes to API Usage\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.spreadshop.com\/blog\/#website\",\"url\":\"https:\/\/www.spreadshop.com\/blog\/\",\"name\":\"The Spreadshop Blog\",\"description\":\"Spreadshop Blog\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.spreadshop.com\/blog\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/678cee42723a944607e63a9022f5f176\",\"name\":\"Lena\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/71eefd0047a3453eaab1f9820b27a885?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/71eefd0047a3453eaab1f9820b27a885?s=96&d=mm&r=g\",\"caption\":\"Lena\"},\"description\":\"Community Manager\",\"url\":\"https:\/\/www.spreadshop.com\/blog\/author\/Lena Reth\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Changes to API Usage - The Spreadshop Blog","description":"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/","og_locale":"en_US","og_type":"article","og_title":"Changes to API Usage","og_description":"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!","og_url":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/","og_site_name":"The Spreadshop Blog","article_published_time":"2017-12-21T13:26:42+00:00","article_modified_time":"2025-08-05T17:27:19+00:00","og_image":[{"width":1400,"height":800,"url":"https:\/\/images.spreadshop.com\/images\/f_auto,q_auto\/v1513860471\/blog\/Article\/General\/MDS-637-BP-API-changes\/MDS-637-BP-API-changes.png?_i=AA","type":"image\/png"}],"author":"Lena","twitter_misc":{"Written by":"Lena","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/","url":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/","name":"Changes to API Usage - The Spreadshop Blog","isPartOf":{"@id":"https:\/\/www.spreadshop.com\/blog\/#website"},"datePublished":"2017-12-21T13:26:42+00:00","dateModified":"2025-08-05T17:27:19+00:00","author":{"@id":"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/678cee42723a944607e63a9022f5f176"},"description":"There\u2019ll be a few important changes coming first thing in 2018 to the Public API. This blog tells you everything you need to know!","breadcrumb":{"@id":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.spreadshop.com\/blog\/2017\/12\/21\/changes-api-usage\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.spreadshop.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Changes to API Usage"}]},{"@type":"WebSite","@id":"https:\/\/www.spreadshop.com\/blog\/#website","url":"https:\/\/www.spreadshop.com\/blog\/","name":"The Spreadshop Blog","description":"Spreadshop Blog","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.spreadshop.com\/blog\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/678cee42723a944607e63a9022f5f176","name":"Lena","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.spreadshop.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/71eefd0047a3453eaab1f9820b27a885?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/71eefd0047a3453eaab1f9820b27a885?s=96&d=mm&r=g","caption":"Lena"},"description":"Community Manager","url":"https:\/\/www.spreadshop.com\/blog\/author\/Lena Reth\/"}]}},"_links":{"self":[{"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/posts\/16727"}],"collection":[{"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/users\/674"}],"replies":[{"embeddable":true,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/comments?post=16727"}],"version-history":[{"count":5,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/posts\/16727\/revisions"}],"predecessor-version":[{"id":29330,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/posts\/16727\/revisions\/29330"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/media\/16764"}],"wp:attachment":[{"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/media?parent=16727"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/categories?post=16727"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.spreadshop.com\/blog\/wp-json\/wp\/v2\/tags?post=16727"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}