doc-exports/docs/vpn/api-ref/vpn_api_1003.html
Hongwei, King Wang 32c06a10a2 vpn_api
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

14 lines
1.7 KiB
HTML

<a name="EN-US_TOPIC_0000001807530336"></a><a name="EN-US_TOPIC_0000001807530336"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_en-us_topic_0020507759_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: https://<em id="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_i137795958918721">Endpoint/uri</em>. In the URL, <em id="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_i842352697154116">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_en-us_topic_0020507759_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="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
<p id="EN-US_TOPIC_0000001807530336__en-us_topic_0000001541136774_en-us_topic_0020507759_p899246910259">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>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1002.html">API Reference - Classic VPN</a></div>
</div>
</div>