Quickstart

This guide will get you all set up and ready to use the 1ClickImpact API. We'll cover how to get started and 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.

Choose your environment

For testing purposes, it is recommended to use the sandbox environment (test mode). The requests made to this environment don't affect the live data. You are not charged since the impact requests are not fulfilled. Data in test mode gets erased after 30 days. To create an impact use the production environment (live mode). The requests made in the production environment create a real world impact and you get charged for it in the next invoice. This documentation provides examples to make requests using cURL, JavaScript, Python, Java and Go.

Making your first API request

After getting your API keys, you are ready to make your first call to the 1ClickImpact API. Below, you can see how to send a GET request to the whoami endpoint to check if API key is valid and associated with your email.

Sandbox Request

GET
/v1/whoami
curl --location https://sandbox.1clickimpact.com/v1/whoami \
--header 'x-api-key: {SANDBOX API KEY}'

Production Request

GET
/v1/whoami
curl --location https://api.1clickimpact.com/v1/whoami \
--header 'x-api-key: {PRODUCTION API KEY}'

What's next?

Great, you're now made your first request to the API. Here are a few links that might be handy as you venture further into the 1ClickImpact API: