API quick start
Start giving in a matter of minutes!
This quick start guide will provide an overview of the steps required to get started with the Giveabl API, including signing up for an account, obtaining an API key, making API requests, and testing and deploying your integration.
If you don't have a Giveabl account already, you’ll need to create one in order to use the API.
Now that you have an account, the next step is to create a team. A team could be your business, non-profit or simply yourself. It is any entity that you wish to use to donate money.
The simplest way to authenticate a request to the Marketing API is using an API key.
Here’s how you can generate one for yourself:
- 2.If you already have an API key listed and you’d like to use it for your application, simply copy it. Once an API key has been revealed, it can not be seen again. In this case, regenerate it.
Otherwise, click Create Key and give it a descriptive name that will remind you which application it’s used for.
It’s important to remember that your Giveabl API key provides full account access, so you should keep it secure, as you would with a password. Because of the potential security risks associated with exposing account API keys, Giveabl does not support client-side calls to the Giveabl API using CORS requests, nor should API keys be used in mobile apps.
Add a credit card to your team's Giveabl account to ensure that you can pay for your pledged donations.
To test that you have everything set up correctly, we’ll make a simple request to the Ping endpoint. Hitting this endpoint acts as a health check on the Giveabl API service; it won’t affect your account in any way.
If everything was set up correctly and the request to ping was a success, the response should look like the following:
"health_check": "Thanks for giving!"
Any request that doesn't include an API key will return an error.
Now that you’re successfully making authenticated requests to the API with your API key, you’re ready to dive into the Giveabl API.
Why not start by pledging a donation? Alternatively, you could browse the API Reference documentation to find out what else you can do with the Giveabl API.