Spreeflo API

The Spreeflo API allows you to automate your workflows and integrate Spreeflo with your other applications. You must be subscribed to the Professional plan to access the Spreeflo API.

This guide will walk you through creating API keys to calling Spreeflo API endpoints. You can find the full API documentation in the API Reference page.

What is an API?

API stands for application programming interface. Think of an API as a way for different apps to talk to one another. You send and receive data between apps using API requests and responses. An API key is a unique series of characters that's included in a request to verify that the requesting system is allowed to communicate with the receiving system.

Create API Key

You need an API key to send alongside your API requests in order to authenticate your requests.

To create an API key, navigate to Settings > API Keys and click + Add API Key. Provide a name for your API key and click Create. Click the clipboard icon to copy your API key.

Revoke an API Key

If an API key has been compromised, or you no longer use the integration that was accessing your account through it, you can revoke that API key. Once you've revoked an API key, it can't be reactivated. You'll need to generate a new key and update any integrations that use the original key.

To revoke an API key, navigate to Settings > API Keys and click the trash icon next to the API key you want to revoke. Click Confirm to revoke the API key.

API key security

API keys grant access to your Spreeflo account. You should protect them the same way you would protect your password. Keep these common scenarios in mind when working with API keys.

Give each integration its own API key. Assign descriptive names to each key so you know which key goes with which app. If a specific API key is compromised, you can revoke that key without disabling access to your other integrations.

Be careful not to expose the key to the public (such as in screenshots, videos, or help documents). Remember that blurring your data isn't always enough. It's best to remove the data completely.

If you need to share access to your account, generate a new key and name it so you'll know which key to revoke, if needed. Never email an API key. This could allow access to your Spreeflo account if hackers were to compromise your email account.

Call Spreeflo API

Follow the code snippets in our API Reference to call the Ping API. This a lightweight and simple API for you to check your API key is valid and able to return API responses.

Need Immediate Help? Contact our support team at support@spreeflo.com or check our other guides for more information.