{"id":2457,"date":"2020-09-25T11:58:15","date_gmt":"2020-09-25T11:58:15","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&#038;p=2457"},"modified":"2026-02-28T01:18:19","modified_gmt":"2026-02-27T23:18:19","slug":"basic-structure-of-the-api-url","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/basic-structure-of-the-api-url\/","title":{"rendered":"Basic structure of the API URL"},"content":{"rendered":"\n<p><strong>API structure<\/strong><br><br>The API is called via a well-defined URL. If an XML file is supplied by a call, it can also be entered in a browser window, for example. The resulting XML is then displayed by the browser.<br><br>The URL consists of:<\/p>\n\n\n\n<p>&lt;Protocol&gt;:\/\/&lt;Host&gt;\/&lt;Version&gt;\/&lt;Method&gt;\/&lt;Dataformat&gt;.&lt;Outputformat&gt;?&lt;Parameter&gt;<br><\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>API base URL: <strong>&#8216;https:\/\/api.itscope.com&#8217;<\/strong>.<\/li>\n\n\n\n<li>Version: the latest version is\u00a0<strong>&#8216;\/2.1<\/strong>.<\/li>\n\n\n\n<li>Method: this may, for example, begin with &#8216;\/products&#8217;. Another method is &#8216;\/search&#8217;, followed by the filters, described in URL path syntax.<\/li>\n\n\n\n<li>Data format: for example <a href=\"https:\/\/guide.itscope.com\/en\/kbtopic\/api-export-data-formats-product-data\/\">standard described in data formats<\/a><\/li>\n\n\n\n<li>Output format: <a href=\"https:\/\/guide.itscope.com\/en\/kbtopic\/api-export-data-formats-product-data\/\">output formats can be CSV, XML or JSON<\/a>.<\/li>\n\n\n\n<li>Parameters: separated from the path with a &#8216;?&#8217; symbol. Additional information, such as for sorting are provided; these are described in URL parameter syntax.<\/li>\n<\/ol>\n\n\n\n<p>Combining these elements results in the link to an API call, for example:<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/products\/search\/keywords=server%20barebone\/standard.xml?sort=DEFAULT\">https:\/\/api.itscope.com\/2.1\/products\/search\/keywords=server%20barebone\/standard.xml?sort=DEFAULT<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>API structure The API is called via a well-defined URL. If an XML file is supplied by a call, it can also be entered in a browser window, for example. &#8230;<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[180],"kbtag":[],"class_list":["post-2457","kb","type-kb","status-publish","hentry","kbtopic-api-basics"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2457","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=2457"}],"version-history":[{"count":4,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2457\/revisions"}],"predecessor-version":[{"id":20186,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2457\/revisions\/20186"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=2457"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=2457"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=2457"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}