Connecting to the APIs

Spotlight NEON supports two ways of authentication

  • Oauth2
  • API Keys

For API Integrations, API keys are generally the way forward, and that's what's described here. Each website or application connecting to the APIs should use its own key. These API keys can be set up in the Portal, or can be requested by contacting SPIKA.

The API Keys are passed in the request header using the Header param X-API-Key.
Example of how to verify that your key is working:

curl -H "X-API-Key: <secret>" <<loyaltyUrl>>/ping

NEON is a multi-tenant platform, supporting any number of clients. Each client is given their own space. You will be assigned a space when we set you up. This space needs to be passed to every api call, as part of the url path.