Public API
Anthony avatar
Written by Anthony
Updated over a week ago

What is an API?

API stands for "Application Programming Interface".

You can think of it as a communication service that programmers can use to interact with Táve, allowing them to push and pull data to and from a Táve account.

An API is generally considered an advanced feature that application developers can use to create apps that interact with your Táve account, or add features that we don't directly support.

For example, an application developer could use the API to create a custom contact form that creates leads directly in Táve, or they could create an integration for an application that retrieves order history from your Táve account without us having to create our own integration for their app!

Not all data will be available on the first release of the API, but as you look at creating applications and integrations be sure to put in a request on our Feature Requests board for any features or data access that you think would be useful to have!

Zapier

Our Zapier integration uses the public API under the hood! It's an example of the kinds of integrations or applications that can be created with this API. This also means that improvements and added features to the public API can also lead to improvements to our Zapier integration as well.

If you're not an application developer, or have one on staff, then an alternative to using our public API is to use our Zapier integration! Check out some help articles about setting up a Zap here.

Getting Started

To get started you'll need to first create an API Key. Think of this as a password that gives access to your account through the API, and you should definitely keep this private!

To create a key, just go to Settings › API Integrations and select New API Key:

You can then enter a name for your new key, as well as choose the permission level. The default permission is Read and Write, which means that anyone with that key can both read data from your account as well as make changes!

You can make as many keys as you need and, generally speaking, any application that needs a key should have a brand new one created just for it (I would name the key after the application that is using it). You'll also be able to delete these keys, and you should do so if you no longer need it, or if you think it might have been compromised in some way, just to be on the safe side.

If you're just looking to read data from the account, then creating a Read Only key would be the way to go!

Once you click Activate Key you'll be presented with the actual Key. Make sure you save this key in a secure location, as once it has been used you'll no longer be able to see the full key for security reasons. If you need to reuse the key at that point, you can just create a new one and delete the old one.

Documentation

Full API documentation is available at https://tave.io.

The first public (and current version at the time of this writing) is V2.

This also means that the base URL for the endpoints is also https://tave.io/v2.

Did this answer your question?