Setup & Authentication

Installation basics are documented on this page

Setup Account

Setting up your Marketplace Account can be done by signing up with a regular Cloutly account. Contact support and we will convert this account into a Marketplace account.

1. Sign up here

Obtain a marketplace account using this sign-up link:

https://app.cloutly.com/sign-up?trial=true

2. Retrieve API key

Settings > API Keys > Show API Key

Note: The API Key is used for server-side requests. Do not make this key public.

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiI2OWZjOTE0Yi1jYzgzLTRjM2ItYjkyMi1hMjI0YzQ5ZDRjNDYiLCJkYXRlSXNzdWVkIjoiMjAyMy0wMS0zMVQxMzoxMzozNS44MzRaIiwiaXNzdWVyIjoiNmNmMjNiODItNDI4Ny00N2Q3LWEyYzctMTVhYzRjYTJkNWM2IiwiYWlkIjoiNmNmMjNiODItNDI4Ny00N2Q3LWEyYzctMTVhYzRjYTJkNWM2IiwiaWF0IjoxNjc1MTcwODE1fQ.ND7sWYgwwkimcRDJ7MMOyv9IPTnJscuHgzH7lSqhpsE

Authentication

You should authenticate all your HTTP requests to Cloutly's API with the help of your API key. To authenticate your HTTP requests, you should add an x-api-key header to EVERY request.

x-api-key: YOUR_API_KEY_HERE

You don't need to do any extra manipulations with your API key. It is long-lived and never expires until rotated from the console. Make sure you pass the entire key without any spaces or extra symbols.

Host API Domain

Cloutly's API is provided on the following HTTPS-only domain:

https://marketplace.cloutly.com/api/v2