Welcome to the Developer Center for Appetize!

Let’s get started on some of the important areas we’ll cover through these guides.

First, we’ll take you step by step to get your store setup in the Connect back office. We’ll guide you through getting the right access permissions, menu configurations as well as any API specific settings you may need to set. We will be sharing links to comprehensive guides along the way, but you only will need to follow the basic help guide steps to get started (we know speed of getting a test environment up is important!).

Once you have everything ready to go, we’ll need to provide you with API access. For security reasons we currently don’t provide self-provisioned keys (given the financial nature of our business), so you’ll need to reach out to your Sales rep or Customer Success Manger to get setup. Once you have an API-Key, you’re ready to enable your API access.

The rest thereafter is up to personal preference!

  • Are you an engineering wizard? Dive right into the API References.
  • Need some guided help to walk you through implementing a specific solution? The API Guides section lines up with the API References for ease of navigation.
  • Interested in learning more about the shared platform standards and implementation details? The Common API Considerations section has everything from versioning guidelines to Postman Collections.

Sign up for Release Notes

Make sure to sign up for release notes to the Appetize API’s as a first step. This will ensure you receive timely updates on bug fixes and new features that may benefit or impact your implementation.
How-to guide: Sign up for release notes.

API category options when signing up for release notes:

Manage your subscriptions and view release notes anytime at support.appetize.com