API

An API as defined within the portal as a set of operations that share a common base path and life cycle.

The product manager creates an API through the portal as either a REST or SOAP API:

• A REST API is usually represented by the set of HTTP verbs supported for a single entity. It can be represented by a Swagger resource specification.
• A SOAP API is typically the set of operations that are exposed for a single service. It can be represented by a WSDL specification.

In addition to an optional specification, documentation can also be uploaded for the API, including attachments and rich text (HTML).

Each API is associated with one or more gateway environments; for example, Staging, Production-Europe, or Production-Americas.

APIs do not become visible to application developers until they are associated with a published product.

Copyright © Cloud Software Group, Inc. All rights reserved.