• API White Paper

wp
  1. Help Center
  2. API White Paper
  3. API Reference
  4. Open Telekom Cloud API Overview
  5. Compatibility Between Open Telekom Cloud API and Native OpenStack
  6. REST API Compatibility Element

REST API Compatibility Element

No.

REST API Compatibility Element

Open Telekom Cloud API Description

1

API group: API quantity or function consistency (API addition allowed)

Some native APIs are filtered out while some APIs are added.

2

API version: API version consistency

An API has a major version and a minor version.

The former is contained in the API URL, and the latter is contained in the HTTP request header.

Newly added APIs comply with the REST API standard.

3

Consistency of API URLs and request or response packets (function names)

Newly added APIs comply with the REST API standard.

4

API protocol: consistency of API communication protocols and authentication methods

In general, REST APIs are called over HTTPS, and requests are authenticated using a token or AK/SK

Newly added APIs comply with the REST API standard.

5

API request: consistency of input parameter formats, names, and types

An API request body contains input parameters. Query and body parameters are supported.

Newly added APIs comply with the REST API standard.

6

API response: consistency of output parameter formats, names, and types

An API request body contains output parameters. Only body parameters are supported.

Yes

Newly added APIs comply with the REST API standard.

7

API semantics: consistency of API functions and context changes

Newly added APIs comply with the REST API standard.

8

API authentication: consistency of API authentication methods and transmission encryption methods

AK/SK is used to enhance security authentication.

  • Besides the preceding explicit elements, API compatibility also involves concurrency performance and response time requirements, and other implicit factors.