[intro] When you have completed this Guide, you will have installed the EKM API feature and will have an automatically generated API key for use with third-party platforms. [/intro]

[warning]This feature will be discontinued on December 31st 2019. There is an upgraded version available to customers on the Advanced and Pro tiers of service. Alternatively, you may want to look at Zapier, which will allow you to integrate your EKM online shop with other third-party platforms.[/warning]

[remember]If you are only using the Linnworks integration with the EKM API (legacy) feature, you don't need to upgrade your EKM online shop. This is because this is a partner integration, managed by Linnworks. [/remember]

The EKM API (Application Programming Interface) is an advanced feature that allows your EKM online shop to interact with other platforms by generating an API key, which is a line of numbers and letters specific to you. You can use the API key with some ready-made platforms, but in the hands of a developer, the API key can be used with custom-made programs too.

Installing the Feature

1. From the Dashboard, click the Features tab:

2. Scroll down to the EKM API feature and click it:

3. Click the green Install Feature button:

4. You’ll then see two fields - the Endpoint and the API key:


[tips]If you are a developer and would like to see examples of SOAP requests and responses, as well as a full list of operations, you can visit the endpoint via a browser.[/tips]

[warning] The API Key is generated specifically for your account. If you think their security may have been compromised, you will need to generate new versions and apply these new details to any third-party platforms that you have configured to use the API. [/warning]

[more]

[/more]

[contact] If you need our help with your EKM online shop, contact your Account Manager or Customer Support, who will be able to point you in the right direction. We're open from 8am-6pm weekdays and 9am-5.30pm on the weekends. If you'd like to suggest a feature or an upgrade on any of the EKM platforms, please let us know on the EKM Suggestions board. If you have a non-account specific question ask the EKM Team, join us in EKM Community.  [/contact]