doc-exports/docs/hss/api-ref/hss_02_0001.html
Li, Qiao a5e72d5590 HSS API 20240206 version
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2024-05-28 20:54:21 +00:00

10 lines
1.7 KiB
HTML

<a name="hss_02_0001"></a><a name="hss_02_0001"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body8662426"><p id="hss_02_0001__en-us_topic_0000001448609361_p1645204610259">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="hss_02_0001__en-us_topic_0000001448609361_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="hss_02_0001__en-us_topic_0000001448609361_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="hss_02_0001__en-us_topic_0000001448609361_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="hss_02_0001__en-us_topic_0000001448609361_b3082532510259">Application/json</strong>.</p>
<p id="hss_02_0001__en-us_topic_0000001448609361_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="hss_02_0001__p12626144610012">An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/additional/endpoints.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>