forked from docs/doc-exports
Yang, Tong
d75e275491
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
10 lines
1.8 KiB
HTML
10 lines
1.8 KiB
HTML
<a name="ces_03_0001"></a><a name="ces_03_0001"></a>
|
|
|
|
<h1 class="topictitle1">API Usage Guidelines</h1>
|
|
<div id="body1536561827536"><p id="ces_03_0001__a253918ebb3b34a26a9ab78ea458aeca7">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="ces_03_0001__a4418e42505ca42c1b6b86db355025a93">https://Endpoint/uri</em>. In the URL, <strong id="ces_03_0001__a0b79c8ead7a6495db92632e3745515ab">uri</strong> indicates the resource path, that is, the API access path.</p>
|
|
<p id="ces_03_0001__a222471448a1b4c6b8fc6e58a4cfabf09">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="ces_03_0001__a35b00c45a80145af8b3b60a7dd1c7fb7">Application/json</strong>.</p>
|
|
<p id="ces_03_0001__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
|
<p id="ces_03_0001__p185084118">An endpoint is the <strong id="ces_03_0001__b7716151719124">request address</strong> for calling an API. Endpoints vary depending on services and regions. For example, the endpoint of the eu-de region is <strong id="ces_03_0001__b13687565511">ces.eu-de.otc.t-systems.com</strong>. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
|
</div>
|
|
|