Internal Bridge Requirements

An overview of data required from the Vendors API for MSPCentric engineers to build against.

🚧

This documentation is still under development.

Endpoints

Auth Test :

Requirements:

  • Low-cost HTTPS endpoint for credential validation. This can be a dedicated endpoint or a small entity GET request.

List Active Customers by MSP/Organization:

Preferred api details:

  • List by MSP
  • Pagination support

Required in payload:

  • Unique Id
  • Friendly Name

Usage:

Preferred api details:

  • List by Customer
  • Pagination support

Required in payload:

  • Current Usage
  • Related Service Id

List Services:

Preferred api details:

  • Active customer services.
📘

We will often utilize Usage API's to deduce what services are relevant for Partners.

Required fields:

  • Unique Id
  • Name
📘

We can statically populate services without the need of an endpoint. This is not recommended for a large number of services.