OEM Customer introduction

Overview​

PubNub's OEM (Original Equipment Manufacturer) Customer API enables partners to manage their end customers and their access to PubNub resources. This API is designed for partners who want to embed, rebrand, and offer PubNub capabilities as part of their own products.

Key Concepts​

Customers​

An OEM customer represents one of your end-users or organizations. Each customer is identified by:

  • A unique internal customer ID assigned by PubNub
  • An externalId that you define (URL-safe identifier from your system)
  • A display name for organizational purposes

Keysets​

Keysets are PubNub's publish/subscribe key pairs. In the OEM model, you assign keysets to customers to grant them access to specific PubNub resources. Each customer can have multiple keysets assigned across different applications.

Typical Workflow​

  1. Create a customer using the POST /oem/customers endpoint with your own externalId
  2. Assign keysets to the customer either during creation or later via POST /oem/customers/:customerId/keysets
  3. Generate access tokens for customer users to access embedded UI features (if using Illuminate or other embeddable interfaces)
  4. Manage customer resources by listing, updating, or filtering by application

Authorization​

All endpoints in this group require partner-level authorizatoion. The authorized account must be added by Pubnub Team to OEM partner program. Please, contact Support to enroll.

For more information about PubNub OEM capabilities, visit: https://www.pubnub.com/docs/illuminate/embed-illuminate-ui