Accessing and Authenticating GraphQL API

Overview

To interact with our GraphQL APIs, you need to authenticate your requests. This ensures that only authorized users can access and manipulate the data. This guide provides an overview of the authentication process for all GraphQL APIs.

Authentication Methods

API Key

For robust and efficient integration, especially when you need to integrate the API into your systems, it's recommended to use an API key. You can generate an API key from the 'API Keys' section on my.helloretail.com. Once you have the API key, you can supply it to the API by appending it as a query string parameter apiKey to the URL.

Example

The URL will then look something like this:

https://core.helloretail.com/[nameOfSubpath]/graphql?apiKey=XXXXXXXXX

or

https://core.helloretail.com/graphql?apiKey=XXXXXXXXX

depending on the API you are accessing.