There are 2 different variants:\n
- \n
- Personal API access for individual use of the API. This variant is described in the section further down.<\/li>\n\n\n\n
- Interface to ITscope for partner systems, which implement a connection for shared customers. Our interface partners receive the respective instructions during the implementation on request.
<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\nPersonal ITscope API credentials<\/h2>\n\n\n\n
Personal login information for the ITscope API can be viewed in the own employee profile<\/a>. These are required for Username:Password HTTP Basic Authentication for the ITscope API.<\/p>\n\n\n\n
Following data is required:<\/p>\n\n\n\n
- \n
- Account ID – this is the username<\/strong><\/li>\n\n\n\n
- API Key – this is the password<\/strong><\/li>\n<\/ul>\n\n\n\n
This allows the ITscope API to be accessed.<\/p>\n\n\n\n
If you need a new API key, you can generate one with the New API Key<\/strong> button. Caution: this will invalidate the old key!<\/p>\n\n\n\n
![\"\"](\"https:\/\/guide.itscope.com\/wp-content\/uploads\/2020\/09\/grafik-22.png\")
<\/figure>\n\n\n\nProgrammatic Authentication via HTTP Basic Authentication<\/h2>\n\n\n\n
For programmatic authentication in the development code<\/strong>, the API user (account ID) and the API password (API key) must be specified in the header, encoded as Base64<\/strong>. To do this, you can use a service like https:\/\/www.base64encode.org<\/a> and encode the Username:Password ‘<Account-ID>:<API Key>’ string. The result of the encoding must then be inserted into the HTTP header Authorization:Basic<\/strong>. If the API URL is entered interactively into the browser, authentication is performed using the browser’s standard mechanisms for ‘Basic Auth’.
<\/p>\n\n\n\nExample pseudo code for an API request:<\/strong><\/p>\n\n\n\n
Example pseudo code for a call via the API ITscope including mandatory HTTP header user-agent<\/a>:<\/p>\n\n\n\n
... \n\/\/ api url without credentials, e.g. \nstring apiurl = \"https:\/\/api.itscope.com\/2.1\/products\/search\/ean=0888462025737\/standard.xml\"; \nHttpWebRequest request = (HttpWebRequest)WebRequest.Create(apiurl);\n\n\n\/\/ username:password Combination Base64 encoded \nstring credentials = <Account-ID>+ \":\" + <API Key> ;\nauthorization = Convert.ToBase64String(Encoding.Default.GetBytes(credentials)); \n\/\/ Basic Authorization as http header \nrequest.Headers[\"Authorization\"] = \"Basic \" + authorization;\n\n\n\/\/ useragent in the form <applicationCompany> - <applicationName> - <applicationVersion> \n\/\/ eg my company-my application-4.0927 \nrequest.UserAgent = \"MyCompany-My-Application-4.0927\" \n\n\/\/Others \nrequest.Method = \"GET\" \nrequest.KeepAlive = True \nrequest.ContentType = \"application\/xml\" \nrequest.AllowAutoRedirect = true \n... \n<\/pre>\n\n\n\n
Examples of programmatic authentication<\/strong><\/p>\n\n\n\n
Example pseudo code for using a generated C # client<\/a> directly from the Swagger Framework of the ITscope API including mandatory HTTP header user-agent<\/a><\/p>\n\n\n\n
...<\/code> \nConfiguration config = new Configuration(); \n \n<\/code>\/\/ username:password combination Base64 encoded \nstring credentials= ApiClient.Base64Encode(\"<Account-ID>:<API Key>\"); \n \n<\/code> \n\/\/ Basic Authorization as http header \nconfig.AddDefaultHeader(\"Authorization\", \"Basic\" +<\/code>credentials); \n <\/code> \n\/\/ useragent in the form <applicationCompany> - <applicationName> - <applicationVersion> \n\/\/ eg my company-my application-4.0927 \nconfig.setUserAgent(\"MyCompany-MyApplication-4.0927\");\n \n\/\/ misc\nProductsApi pApi = new ProductsApi(config); <\/code>\n\n...<\/pre>\n\n\n\nExample pseudo code header for a PHP script:<\/strong><\/p>\n\n\n\n
....<\/code><\/p>\n\n\n\n\/\/ username:password combination Base64 encoded \n\/\/ Basic Authorization as http header \nheader('Authorization: Basic '.base64_encode(\"<\/code><Account ID>:<API Key>\")); \n<\/code> \n\n \/\/ useragent in the form <applicationCompany> - <applicationName> - <applicationVersion> \n \/\/ e.g. my company-my application-4.0927 \nheader('UserAgent:MyCompany-MyApplication-4.0927');\n....<\/code><\/pre>\n\n\n\nExample pseudo code header for a PHP script with curl:<\/strong><\/p>\n\n\n\n
\n\/\/ username:password combination not Base64 encoded when the curl option CURLAUTH_BASIC is set,\n\/\/ then curl executes a Base64 encoding itself\n$UserPWD = \"<Account ID>:<API Key>\";\n\n$url = \"https:\/\/api.itscope.com\/2.1\/products\/search\/ean=<\/code>0888462025737\/standard.xml\";\n$UserAgent = $_SERVER['HTTP_USER_AGENT'];\n \n$pptions = array (CURLOPT_URL => $url,\n CURLOPT_HEADER => true,\n CURLOPT_USERAGENT => $UserAgent,\n CURLOPT_HTTPAUTH => CURLAUTH_BASIC,\n CURLOPT_USERPWD => $UserPWD);\n$ch = curl_init();\ncurl_setopt_array($ch, $options);\n$Data = curl_exec($ch);\n....\n<\/code><\/pre>\n\n\n\n
Simple browser authentication<\/h2>\n\n\n\nThe easiest way to call up the export via browser<\/strong>, wget<\/strong> or in Windows task planning<\/strong> etc. is to pass the authentication directly in the URL (the user must always have an entry in the Account ID field, see above!)<\/p>\n\n\n\n
Note: this method does not work in Internet Explorer.<\/p>\n\n\n\n
An example of a retrieval in the browser for an export<\/strong><\/p>\n\n\n\n
https:\/\/<Account-Id>:<API Key>@api.itscope.com\/2.1\/products\/exports\/<EXPORT-ID><\/pre>\n\n\n\n
If you do not enter the user name <accountID> or the password <API key> when retrieving the URL, authentication is performed via the standard mechanism of the browser for ‘Basic Auth’ and you are prompted to enter the credentials in a separate window.
<\/p>\n\n\n\nITscope authentication<\/h2>\n\n\n\n
This type of authentication is primarily intended for deeplinks into the platform and requires an active session on ITscope. If no active session exists, you will be directed to the login page. To do this, append the API URL with ‘itscope’ for the ‘auth’ query parameter. A call then looks as follows:
https:\/\/api.itscope.com\/2.1\/products\/ean\/0886111583935\/deeplink.html?auth=itscope<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"Authentication methods There are three authentication methods to use the API: Personal ITscope API credentials Personal login information for the ITscope API can be viewed in the own employee profile. These …<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[180],"kbtag":[],"class_list":["post-2455","kb","type-kb","status-publish","hentry","kbtopic-api-basics"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2455","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=2455"}],"version-history":[{"count":6,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2455\/revisions"}],"predecessor-version":[{"id":18446,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2455\/revisions\/18446"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=2455"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=2455"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=2455"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- API Key – this is the password<\/strong><\/li>\n<\/ul>\n\n\n\n
- Account ID – this is the username<\/strong><\/li>\n\n\n\n