Knowledge Base

API Guide for Service Integration (5.0)

Overview

Cloudmore's platform integrates with external services through the API. When setting up a service, you can configure provisioning via email notification or via a webhook call. The webhook option enables end-to-end automation using a Cloudmore Service Connector as middleware.

See the Swagger Documentation for full details on each API call.

Seller Services API

Services are created under a seller and published to the Marketplace for brokers.

Seller Service

Operation

Method

API

Create a service

POST

/api/sellers/{sellerId}/services

Return a service

GET

/api/sellers/{sellerId}/services/{id}

Return all services

GET

/api/sellers/{sellerId}/services

Update a service

PUT

/api/sellers/{sellerId}/services/{id}

Delete a service

DELETE

/api/sellers/{sellerId}/services/{id}

Return resellers with the service

GET

/api/sellers/{sellerId}/services/{serviceId}/resellers

Return service custom properties

GET

/api/sellers/{sellerId}/services/{id}/custom-properties-data

Return service categories

GET

/api/services/categories

Seller Service Products API

Products are created under a service and are what organizations purchase to create subscriptions.

Seller Service Products

Operation

Method

API

Create a product

POST

/api/sellers/{sellerId}/services/{serviceId}/products

Return a product

GET

/api/sellers/{sellerId}/services/{serviceId}/products/{id}

Return all products

GET

/api/sellers/{sellerId}/services/{serviceId}/products

Update a product

PUT

/api/sellers/{sellerId}/services/{serviceId}/products/{id}

Delete a product

DELETE

/api/sellers/{sellerId}/services/{serviceId}/products/{id}

Retrieve email templates

GET

/api/sellers/{sellerId}/settings/EmailTemplates

Seller Service Product Add-ons API

Operation

Method

API

Create an add-on

POST

/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons

Retrieve an add-on

GET

/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}

Retrieve all add-ons

GET

/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons

Update an add-on

PUT

/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}

Delete an add-on

DELETE

/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}

Publish Service API

Once a service is set up, it can be published to specific brokers, regions, or all brokers.

Operation

Method

API

Publish a service

PUT

/api/sellers/{sellerId}/services/{id}/publish

Get market regions

GET

/api/services/marketRegions

Get market countries

GET

/api/services/marketCountries