Tips

Here are some tips for new and existing vendors integrating to our API. We'd also highly recommend utilizing the robust search functionality in the top right corner.

Guidelines

To ensure a seamless integration with our API, please design your API with dynamic data and scalability in mind, implementing clear versioning and robust error handling. This flexibility will help maintain compatibility and performance as our systems evolve.

Integration Workflow

1. Vendor reviews documentation
2. Vendor receives simulation and production credentials from Pax8
3. Vendor configures separate webhooks for both simulation and production credentials
4. Vendor conducts successful simulation testing for all applicable provisioning order types outlined in API documentation and verifies with Pax8
5. Vendor and Pax8 verify all technical requirements are met
6. Vendor reconfigures the webhook with production credentials to allow for production testing
7. Pax8 provides applicable data mapping requirements to vendor
8. Vendor and Pax8 conduct and verify successful production testing

Testing

Pax8 does not have a sandbox environment where you can log in and test this integration, nor can you experience the full order-to-cash process from a partner's perspective. Instead, we offer a non-UI simulation environment for testing provisioning orders. For more detailed guidance, please refer to Provisioning Integration Testing and Provisioning Simulation Example.

Please note that simulation testing for usage is not available at this time. The recommended method for testing usage is to partner with Pax8 for a production test using a test subscription ID.

Additionally, it's important to differentiate between the webhook configurations using production credentials and simulation credentials:

The webhook configuration created with production credentials is separate from the one created with simulation credentials.

When transitioning to production testing, ensure that the webhook is connected to production credentials, not simulation credentials.

Understanding Billing Models for API Integration

When integrating with our API, it's essential to understand our two primary billing models and their respective requirements:

Bill Ahead/Entitlement

In this model, Pax8 serves as the source of truth. We initiate a provision request that includes the license quantity sent to you. Your integration should focus solely on the Provisioning Endpoints to manage orders and subscriptions effectively. It's crucial that partners or customers cannot alter the quantity in your system as it must align with our records to prevent discrepancies. This model supports both monthly and annual billing, indicated by "billingTerm" in the Provision Request.

Billed in Arrears/Usage-Based

This model bills based on the previous month's usage. No quantity is passed from Pax8 to you. Instead, you submit daily usage data to Pax8. Your integration needs to cover both the Provisioning Endpoints and Usage Endpoints to accurately track and bill for usage.

Both models can accommodate Commitment Terms, such as monthly payments with annual commitments.