​
Overview

API Access Setup

To use the Roastify API, you must:
  • Enable API access in the Developers section
  • Add a payment method (required before creating an API key)
  • Generate and manage your API keys

​
Setup Guide

1

Go to Developers SectionIn the Roastify dashboard, open the sidebar and click Developers.
2

Enable APIClick the Enable API button to activate API access for your account.
Developers sidebar
3

Add a Payment MethodBefore you can create an API key, you must have a valid payment method on file. If prompted, follow the instructions to add your payment method.
Add payment method
4

Create an API KeyOnce API access is enabled and a payment method is on file:
  1. Go to the API Keys tab in the Developers section
  2. Click Create key
  3. Select environment (Test/Live) and add an optional description
Copy your API key immediately – it’s only shown once and cannot be retrieved later.
API key creation
API key details
5

Key ManagementTo replace a compromised key:
  1. Revoke the old key
  2. Generate a new one
Revoking API key
6

Start IntegrationBegin using the API with your new key. Check our API reference for endpoints and examples.

Next Steps