A NEW ERA OF INTELLIGENT QUANTITATIVE ECOMMERCE - THAT WORKS FOR YOU ECOMMERCE - THAT WORKS FOR YOU
Knowledge Base
+
Admin Messages (1)
+
Common Tasks (1)
+
Insights (1)
+
Interventions (1)
+
Languages (1)
+
Questions & Answers (1)
+
Reviews (1)
+
Site Scripts (1)
+
Web Services (1)

API - API Keys

How Tos (1)

You can find this section under Server Management > API Keys in the IRP Admin left navigation menu.

You use this section to enable API Request Handling, generate secure API Key-Shared Secret pairs to 'sign' and verify each message, and to ensure that only specific IP Addresses can send posts to the API Key. You can then make use of various methods within APIs such as the Baskets API which you use for adding items to baskets on Desktop, Trade and Mobile sites. For full details, see API - Getting Started.

APIKeys.aspx Page

The main APIKeys.aspx page appears as follows:

API Keys page

This shows the following details:

  • ID: This is the unique IRP ID of the API Key, generated automatically by the IRP system.
  • API Key: This shows the generated API Key.
  • IP Address Restricted?: This indicates whether or not the API Key will accept posts only from specific IP Addresses.
  • Number Of Permitted IP Addresses: This shows the number of IP Addresses that can send posts to the API (if any).
  • Date Added: This shows the date and time when the API Key was added using IRP Admin.
  • Edit: Click this button to make changes to an API Key. For details, see the How To Generate an API Key and Add IP Address Restrictions article later in this section.

At the top of the page you can use the following buttons:

  • Enable / Disable API Request Handling: This is the main switch for enabling and disabling the API functionality. While the API is disabled, you can still create and set up API Keys however no requests posted to the API will be handled. For more details, see the How To Generate an API Key and Add IP Address Restrictions article later in this section.
  • Generate New API Key: Click this button to automatically generate a new API Key and Shared Secret pair that is required to perform functions with the API. For more details, see the How To Generate an API Key and Add IP Address Restrictions article later in this section.

API Key Log

The Log tab on the APIKeyEdit.aspx page contains an audit trail of all actions that Admin Users have carried out for the API functionality.

Using the IRP API

For informaton about using the IRP API, see API - Getting Started.



How To Guides (1)


Copyright © 2018 IRP Commerce. Use of this website constitutes acceptance of the IRP World Terms of Use, IRP Privacy Policy and IRP Cookie Policy
IRP Commerce is a Trading Name of Export Technologies Limited, a Deloitte Fast 50 Company six times: 2010, 2011, 2012, 2013, 2014 & 2018   Deloitte.