doc-exports/docs/smn/api-ref/en-us_topic_0036017316.html
Zaoxu, Li 152a7d9381 SMN API DOC
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-20 15:01:38 +00:00

9 lines
1.3 KiB
HTML

<a name="en-us_topic_0036017316"></a><a name="en-us_topic_0036017316"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body8662426"><p id="en-us_topic_0036017316__p105121142811">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="en-us_topic_0036017316__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL,<strong id="en-us_topic_0036017316__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_0036017316__p26499422919">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_0036017316__en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
<p id="en-us_topic_0036017316__p42011412113016">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>
</div>