Get started¶

This page guides you through setting up an API Key, making an API request for your first test payment, and installing one of our server-side libraries.

Get your API-key¶

To use the Marigold Engage API, you need create an application (Service Account), which will generate authentication and secret keys to interface with the API.  

1. Log in to Engage

2. Go to Admin Config > Access Management > Service Accounts

3. Add a new Service Account by entering an Account name, select type Custom

4. Click Save to generate a new API key & secret

5. Provide the correct Endpoint access to the credentials.

Click here more details on how to generate your API key.

The API key & secret are linked to the Service Account. Most of the API endpoints require the API key information to authenticate the requests.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as versioning systems or client-side implementations.

Doing your first API request¶

To verify that the API key is working correctly, let's do a simple API request

The API key & secret, you've received can be used in the header for the X-ApiKey key with the API key & secret as value.

^{EXAMPLE: API key: 123FdvI0ff5Uqqvc9nhk9Mc1nX3A= with API secret: 456vWKwr99kWcJjtRV8bwm2yy=}

The X-ApiKey header is build up as the combination of the api key:api secret. The authentication values are joined by the : character.

Here's a curl example of how you can authenticate against the API. In the code below, replace YOUR_API_KEY & YOUR_API_SECRET with your API key & secret.

curl https://api.selligent.com/v2/ping \
-H "X-ApiKey: YOUR_API_KEY=:YOUR_API_SECRET" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json'

Next step, start building!¶

You are all set to start building your marketing communication solutions.

Want to get started but not quite sure how?
We are happy to help and get you started, feel free to get in touch with our support team.