How to Use Provisioning Endpoints

Below is a quick introduction to the basics of using the provisioning endpoints.

Base Url

The base url for all requests is https://api.pax8.com/v2

Terminology

The Pax8 Provisioning API provides a way for Vendors to easily fulfill Pax8 Orders. Here are a few key terms:

• Provision - To fulfill a Pax8 Order by creating the necessary cloud resources, communicating
  results to Pax8, and sending credentials for the cloud resources to the Partner.

• Partner - A Pax8 Partner, also known as a Managed Service Provider (MSP). Partners
  manage cloud software for Companies and are Pax8's primary users.

• Company - A Pax8 Company, also known as an End User. Companies buy
  cloud software and support from a Partner.

• Provisioner - An entity that provisions Pax8 orders, also known as a Pax8 Vendor.

• Subscription - A subscription record in Pax8 for a specific Partner/Company/Product combination in the Pax8 system.

How Provisioning Works

1. Partner orders from Pax8
2. Pax8 sends ProvisionRequest, ProvisionDetail, and ProvisionAttempt via Webhook
3. Provisioner provisions cloud resources
4. Provisioner emails Partner information and credentials for cloud resources
5. Provisioner notifies Pax8 with ProvisionResults using the Provisioning API
6. Partner has a Subscription in Pax8 they can then modify or cancel at any time

OpenAPI Spec

You can find the complete OpenAPI Spec for the provisioning API here: https://devx.pax8.com/openapi/6614696de22531001ec2895e