With our API, you can program any action on your website or software to trigger a Tree-Gift for your customers. Our API is our most powerful tool that lets you plant and offer trees with the level of customization you desire.
What the API does
To summarize, the most important feature of our API is to let you plant trees for any action. This includes selecting the project and species to plant, and also the option to receive the Tree-Gift URL in return. With this URL, the recipient will be able to collect and plant his tree on our platform. You can also decide who sends the Tree-Gift email to the recipient: Tree-Nation or yourself.
You can use the default tree message or create new ones.
With more advanced features, you can create a Tree-Nation user profile for your corporate clients. You can also manage and distribute credits to those clients.
Under our API package, we also include some RSS feeds so you can collect information about a project or your forest and plug this content directly into your software.
The rest is handled on our platform.
Check our documentation
Click on this link to find our API documentation on Postman.
Click on this link to find our API Manual.
Define the API configuration that best fits your needs
When we set up your API, we will send you 2 pieces of information: your forest ID and your API token.
There are various ways to use the API:
- 2 levels: you plant trees for your customers. Learn more.
- 3 levels: you act as a platform and plant trees on behalf of your B2B clients for their end clients. Learn more.
When we provide you your token, we assume a default settings configuration:
- you are using a "2 levels" configuration.
- Tree-Nation sends the Tree-Gift emails.
- you will pre-credit your account by credit card.
If this default configuration doesn't correspond to the way you intend to use the API, please let your Forest Success Manager know and we will swiftly modify the configuration.
Start testing
To get started, we will give you access to our test website. There you will be able to test the integration of the API. When ready, let us know and we will provide you with a token code for our live website.
To get your API Test Token and access to the test site, please fill out this form:
Note
Please also check that you have the correct payment configuration.
If you are testing our API on our test site, we will give you free credits in advance.