Quickstart

This guide will get you all set up and ready to use the Shopmonkey API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Create a Shopmonkey API Key

Before you can use the Shopmonkey API, you need to create an API key.

Choose your client

Next, pick which API client you will use. For all the examples in this documentation, we'll use the cURL command line tool.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

Before you start making API requests from examples in the documentation, we recommend setting an environment variable SM_TOKEN. All the examples in this documentation assume this variable is already set in your environment.

After setting your API Key to an environment variable, you are ready to make your first call to the Shopmonkey API. Below, you can see how to send a GET request to the API Key Status endpoint to check that your API Key is valid and that you are passing it correctly to the Shopmonkey API as a bearer token.

curl https://api.shopmonkey.cloud/v3/auth/api_key/status \
  -H "Authorization: Bearer ${SM_TOKEN}"

If successful, you will get a 200 code with a JSON object in the response body.

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you explore how to use the Shopmonkey API:

• Get Started using the API

• Learn about Enterprise Data Streaming