1. ChannelEngine Help Center
  2. ChannelEngine
  3. Getting started

Articles in this section

See more

Merchant API: get API access

  • Created
  • Updated

About this article

This article describes how to create a Merchant API key within the ChannelEngine web application and use it for authentication.

Table of contents

Create a Merchant API key

Use an API key for authentication

Create a Merchant API key

To create an API key in your ChannelEngine account:

  1. Go to Settings, Merchant API keys.
  2. Click Add and enter a name to describe the key.
  3. Click Add again.

ChannelEngine_-_API_keys.png

The newly created API key can be tested via the API reference or with an API tool like Postman.

NB: make sure that you are using the correct URL when connecting to ChannelEngine, and not demo.channelengine.net. Using the demo account results in the error { "StatusCode": 401, "LogId": null, "Success": false, "Message": "API key is unknown: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "ValidationErrors": {} }.

Use an API key for authentication

Although it is possible to authenticate an API using a key directly in the URL, certain webservers log URLs – making this an unsafe practice.

ChannelEngine recommends you do the authentication by inserting the API key in a request header. E.g.: 

GET /something HTTP/1.1
X-CE-KEY: 0001112223334445556667778889991010101111

Related articles

Comments

0 comments

Article is closed for comments.