cloudesire documentation

cloudesire documentation

  • Docs
  • API
  • Syndication
  • Glossary
  • Back to cloudesire.com

›API

Platform

  • Home
  • Platform modules
  • Glossary
  • Users and permissions
  • Billing
  • Event notification
  • Channel management
  • Live reporting
  • Orders approval workflow
  • Vendors approval workflow
  • Customer Cloud Credentials
  • Cloud providers
  • Email automation
  • Marketplace customization
  • Integrations
  • Open Source
  • GDPR Compliance

Products Onboarding

  • Onboarding a new product
  • Product types

    • Syndicated applications
    • Cloud Services
    • Virtual-Machines
    • Services
  • Pricing Plans
  • Pricing models
  • Extra Resources
  • Order validation
  • External configuration parameter values

Available Integrations

  • vCloud VDC
  • OpenStack VDC
  • OKD projects
  • Commvault tenants
  • vCloud Availability tenants
  • Public Cloud Tenants
  • Kubernetes as a service
  • Helm charts
  • Google Workspace
  • Microsoft CSP
  • API as a Service
  • Keycloak

API

  • REST API Introduction
  • Java Client
  • TypeScript Client
  • PHP Client
  • API Reference
Edit

Cloudesire REST API Reference

We use Springfox to autogenerate Swagger definitions for the Cloudesire API.

API are grouped into different areas:

  • Billing API: Subscription, Invoice, Order and many resources useful when developing a Syndicated application
  • Catalog API: Product, ProductVersion, ExtraResource... Useful when mass import of products into the catalog
  • Channel API: Distributor and Reseller price lists, useful for mass import of price lists
  • Cloud Apps API: for BareVM products
  • Cloud providers API: to manage the available Cloud Providers, Instance Types, and their pricing
  • Users API: users and companies
  • Admin API: administrative API, mainly for maintenance purposes
  • Environment API: the configuration of the entire platform

Swagger endpoints are reachable at (concatenate to API domain):

  • /v2/api-docs?group=admin
  • /v2/api-docs?group=billing
  • /v2/api-docs?group=catalog
  • /v2/api-docs?group=channel
  • /v2/api-docs?group=cloudApps
  • /v2/api-docs?group=cloudProviders
  • /v2/api-docs?group=users
  • /v2/api-docs?group=environment

You can use those endpoints to generate swagger clients in a variety of programming language leveraging the swagger-codegen project.

You can also easily generate a Postman collection, as detailed here (archived version)

Last updated on 3/23/2022 by Matteo Giordano
← PHP Client
Pages
Documentation IndexAPI ReferencePlatform modulesOpen SourceCorporate website
Social
TwitterFacebookGitHub
Copyright © 2022 Cloudesire.com by Engineering D.HUB