API Guide for Service Integration

Overview

Cloudmore’s adaptable platform seamlessly integrates with external services, allowing them to be showcased in the Cloudmore marketplace.

When setting up a service in Cloudmore, you have two provisioning options:

Triggering an email (OR)
Initiating a webhook call.

The email option provides a straightforward and quick start-up method, suitable for initial stages or lower volumes. It can be easily configured within minutes through the Cloudmore user interface.

On the other hand, the webhook call option enables comprehensive, end-to-end automation between Cloudmore and external services.

Utilizing webhooks requires a Cloudmore Service Connector. This connector acts as middleware, hosted externally, and serves as an intermediary, translating and relaying communications between Cloudmore and the external service.

Introduction

The purpose of this document is to allow Cloudmore Cloud Service Brokers and Sellers in Cloudmore to manage services and subscriptions and retrieve billing information.

The Cloudmore API enables the automation of routine tasks such as:

Retrieve service and product information to display in their online portals.
Create customers and users in Cloudmore and external cloud services.
Create subscriptions for different services and assign subscriptions to users.
Suspend, cancel, and delete subscriptions.
Configure and update pricing for products and set customer-specific prices.
Retrieve billing information to integrate with external ERP and financial reporting systems.

This API documentation explains how to access the Cloudmore API and includes examples to help you get started. For detailed and updated information about each API call, please see our Swagger document: Swagger UI.

Key concepts used in Cloudmore and the document

Key Steps for Integration Setup

Creating a Seller Service

A service can be created under a seller, which would appear in the marketplace for brokers.

Note: Before creating the service, a request will have to be performed in order to retrieve a list of categories, which is a required input parameter when creating a service.

API Details

Seller Service

Operation	Swagger Description	Method	API
Create Service	Creates a new service for the seller	POST	`/api/sellers/{sellerId}/services`
Return a Service	Returns seller service by identifier	GET	`/api/sellers/{sellerId}/services/{id}`
Return all Services	Returns all seller services	GET	`/api/sellers/{sellerId}/services`
Update a Service	Update the service for the seller	PUT	`/api/sellers/{sellerId}/services/{id}`
Delete a Service	Disables service for the seller	DELETE	`/api/sellers/{sellerId}/services/{id}`

Other

Operation	Swagger Description	Method	API
Return a list of resellers with the service	Returns the list of resellers who have signed the seller’s services	GET	`/api/sellers/{sellerId}/services/{serviceId}/resellers`
Return services custom properties	Returns seller service custom property data	GET	`/api/sellers/{sellerId}/services/{id}/custom-properties-data`
Return a list of categories	Retrieve service categories	GET	`/api/services/categories`

For more details related to the APIs, refer to the Swagger Documentation related to Seller Services.

Creating a Seller Service Product

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

Note: To create a product, a service identifier is needed to create the product under the right service. If you plan to use email notifications, the email templates should be created in Cloudmore and can be retrieved through the API.

API Details

Seller Service Products

Operation	Swagger Description	Method	API
Create a Product	Creates a new product for the Seller service	POST	`/api/sellers/{sellerId}/services/{serviceId}/products`
Return a Product	Returns seller service product details	GET	`/api/sellers/{sellerId}/services/{serviceId}/products/{id}`
Return all Products	Returns all seller service products	GET	`/api/sellers/{sellerId}/services/{serviceId}/products`
Update a Product	Update the seller service product	PUT	`/api/sellers/{sellerId}/services/{serviceId}/products/{id}`
Delete a Product	Deletes seller service product	DELETE	`/api/sellers/{sellerId}/services/{serviceId}/products/{id}`

Other

Operation	Swagger Description	Method	API
Retrieve Email Templates	Returns all seller email templates	GET	`/api/sellers/{sellerId}/settings/EmailTemplates`

For more details related to the APIs, refer to the Swagger Documentation related to Seller Service Products.

https://developer.cloudmore.com/guides/service-integration/common-scenarios/seller/creating-a-seller-service-product/ ~~- same as above~~

Creating a Seller Service Product Addon

If the product is designed to support add-ons, you can create an add-on accordingly.

Note: The product identifier is necessary to initiate this process to create the addon under the right product.

API Details

Seller Service Product Addons

Operation	Swagger Description	Method	API
Create an Addon	Creates a new product addon for the Seller service	POST	`/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons`
Retrieve an Addon	Returns seller service product addon	GET	`/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}`
Retrieve All Addons	Returns all seller service product addons	GET	`/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons`
Update an Addon	Updates Seller service product addon	PUT	`/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}`
Delete an Addon	Deletes the Seller service product addon	DELETE	`/api/sellers/{sellerId}/services/{serviceId}/products/{productId}/addons/{id}`

Other

Operation	Swagger Description	Method	API
Retrieve Products	Returns all seller service products	GET	`/api/sellers/{sellerId}/services/{serviceId}/products`

For more details related to the APIs, refer to the Swagger Documentation related to Seller Service Product Addons.

Publishing a Service

Once a service has been set up, it can be published to a particular market in order to be available to brokers. Services can be published to:

All brokers
To specific regions
To specific countries
To the seller's brokers
To specific brokers

Note: If publishing a service to a specific region or country, an additional API call will have to be made to get a list of regions or countries.

API Details

Seller Service Publish

Operation	Swagger Description	Method	API
Publish a service	Publishes service	PUT	`/api/sellers/{sellerId}/services/{id}/publish`

Other

Operation	Swagger Description	Method	API
Get Market Regions	Retrieve market regions	GET	`/api/services/marketRegions`
Get Market Countries	Retrieve market countries	GET	`/api/services/marketCountries`

For more details related to the APIs, refer to the Swagger Documentation related to Seller Service Publish.