Requests and API Keys

To enable communication between your application and Shutterscore, you'll need your API Keys. Shutterscore authenticates every request your application makes with these keys. Generally, every account comes with two sets of API keys - public(PUBK_) and secret(SECK_) and these API keys work in 2 modes of environments - test(TEST_) and live(LIVE_).

Your public and secret keys are to be kept secret and confidential. They are required for accessing any financial data and can be used to make any API call on your account. Your keys should never be shared on any client-side code. Treat them like any other password. And, if for any reason you believe your keys have been compromised simply reset them by generating new keys. You can generate new API keys from your dashboard.

Obtaining your API Keys

Your API keys are always available on your dashboard. To find your API keys,

  • Login to your dashboard.
  • Navigate to API Configuration under Settings on the side menu.
  • In the API Configuration Tab, you’d see both your Public and Secret keys, and a button to Generate New API Keys.

🚧

Note

The API keys in test mode are different from the API keys in Live mode. So you need to always ensure that you do not misuse the keys when you switch between modes.

Generating new API Keys

You should always keep your API keys safe and protect your account. However, in the event where your API keys have been compromised, you can easily generate new API keys. Simply click the 'Generate API Keys' button under the API Configuration tab on the Settings page.

Once you generate new API keys, the old keys become void - you can no longer use them to make API calls. Make sure to update your application to use the newly generated keys.

JSON Payload

To ensure that your requests are received and parsed correctly, the request body must be sent in JSON format. You must also add the "Content-Type" property with value as "application/json" to the header.