Guides

Integrator Setup Guide

Suggest Edits

Welcome to the Pax8 Integrator Program! This guide walks you through the steps to get started with building and publishing your integration using Pax8 APIs and events.

1. Initial Contact

To begin, email [email protected] with the following information:

  • Full Name of the primary contact
  • Email Address (preferably a distribution list if multiple users need access)
  • Company or Integration Name (as it should appear in the Pax8 Integrations Hub that will be visible to Pax8 partners)

Once received, we’ll provision access to the Pax8 Integrator Portal.

2. Access the Integrator Portal

Once your account is created, you’ll receive credentials to log into the Integrator Portal. This portal provides:

  • Sandbox Environment: Includes mock data for testing your integration.
  • OAuth Setup Tools: Configure your OAuth 2.0 flow to allow Pax8 partners to authorize your app.
  • Vendor Profile Editor: Fill out your company’s profile, which will be displayed in the Pax8 Integrations Hub to partners.

3. Build Your Integration

You’ll use Pax8’s public APIs and events to build your integration. Key resources include:

Use the sandbox credentials to test your integration before going live.

4. Test and Validate

Once your OAuth flow and API calls are working in the sandbox, you can:

  • Validate your integration with real-world scenarios
  • Confirm that your app can authenticate Pax8 partners and access their data securely
  • Ensure your vendor profile is complete and accurate

5. Go Live and Get Discovered

After successful testing:

  • Your integration will be listed in the Pax8 Integrations Hub, visible to over 40,000 Pax8 partners
  • Partners can discover and link to your integration page directly from within the Pax8 platform

6. Support and Troubleshooting

If you encounter issues:

Updated 3 days ago