API URL

Table of Contents

• General
• Stage
• API name
• Version
• Endpoint

---

General

Qilin.Cloud have different APIs. They are constructed by the following scheme:

https://<stage?>api.qilin.cloud/<apiName>/<version>/<endpoint>

There are 4 parameters for the routing:

• stage
• apiName
• version
• endpoint

Stage

Qilin.Cloud is a continuously improved product. While some stages are public, other are more restricted or even private. To seperate between them, Qilin.Cloud is usings stages:

Name	URL segment	Publicity	Explanation
Development	https://dev.api.qilin.cloud	no public access	This stage is used for internal development on new features and bugfixing, as well as QC & QA
Test	https://test.api.qilin.cloud	restricted public access	This stage is used to let specified alpha/beta user test a new feature / bugfix. This test should never be productive and the user must know, that unexpected problems can occur. If you want to be able to use this stage, please apply on qilin.cloud/early-access)
Productive	https://api.qilin.cloud	public access	This stage is used for productive environments

API name

Qilin.Cloud offers a variety of different APIs. You could find them all in our GitHub repositories or just use the GitHub search: Show me the API repositories

You will find the API name in the endpoint documentatio.

The API name segment must follow the stage-combined base URL - for example:

https://api.qilin.cloud/products/

Version

The version is specific for each API (diffenciated by its API name). You will find the different possible versions in the endpoint documentatio.

💡 For more information about the API versioning, please read carefully this: API versioning

The API version segment must follow the combination of stage, base URL and apiName - for example:

https://api.qilin.cloud/products/v1.0.1

Endpoint

Each Qilin.Cloud API have different endpoints. You will find the endpoints in the endpoint documentatio.

The endpoint segment must follow the combination of stage, base URL, apiName and version - for example:

https://api.qilin.cloud/products/v1.0.1/brand