# API | HTTP

## **Pendahuluan** <a href="#api-introduction" id="api-introduction"></a>

Antares menggunakan approach RESTful dalam mengembangkan API sehingga API yang disediakan lebih representatif dan mudah digunakan user. Sebuah API terdiri atas URL dan parameter.

### **URL**

URL merupakan kependekan dari Uniform Resource Locator. URL dalam bahasa sederhana adalah link. URL tersusun dari domain dan diikuti port. Dalam banyak kasus, https tidak terlihat portnya, ketika server tersebut menggunakan port default (443). Oleh karena itu, server yang tidak menggunakan port default, harus dicantumkan portnya, contoh

```http
https://platform.antares.id:8443
```

Penjelasan lebih detail terkait RESTful API bisa didapatkan di <https://www.restapitutorial.com/>

### **Parameter**

Parameter digunakan ketika ingin menginputkan sesuatu melalui API. Parameter bisa terdapat di Headers, Path, dan Query String Parameter.

### **Header Parameter**

<table><thead><tr><th width="209"></th><th></th></tr></thead><tbody><tr><td>X-M2m-Origin</td><td><mark style="color:red;"><code>{{access-key}}</code></mark></td></tr><tr><td>Content-Type</td><td><mark style="color:red;"><code>application/json;ty=3</code></mark></td></tr><tr><td>Accept</td><td><mark style="color:red;"><code>application/json</code></mark></td></tr></tbody></table>

### **Path Parameter**

```http
https://platform.antares.id:8443/~/antares-cse/antares-id/{{your-application-name}}
```

### **Query String Parameter**

Query string parameters digunakan dengan simbol tanda tanya (?) di URLnya. Setelah tanda tanya (?) adalah parameter dan nilainya yang dihubungkan dengan simbol sama dengan (=). Setiap query string parameter dipisahkan dengan simbol (&).

```http
https://platform.antares.id:8443/~/antares-cse/antares-id/{{your-application-name}}?fu=1&ty=3&lim=5
```

Penjelasan lebih detail terkait parameters silahkan dapatkan di <https://idratherbewriting.com/learnapidoc/docapis_doc_parameters.html>

## List Query String Parameter

<table><thead><tr><th width="188"></th><th width="122.33333333333331"></th><th></th></tr></thead><tbody><tr><td><strong>Parameter</strong></td><td><strong>Value</strong></td><td><strong>Keterangan</strong></td></tr><tr><td>fu</td><td>0</td><td>Non-aktifkan Filter</td></tr><tr><td></td><td>1</td><td>Aktfikan Filter</td></tr><tr><td>lim</td><td>n</td><td>Jumlah Respon yang dihararapkan</td></tr></tbody></table>

{% content-ref url="/spaces/SG57S3sc1YOZETuRdW3k/pages/YiBtNZGr2EUkUmTvWqYS" %}
[Broken mention](broken://spaces/SG57S3sc1YOZETuRdW3k/pages/YiBtNZGr2EUkUmTvWqYS)
{% endcontent-ref %}

{% content-ref url="/spaces/SG57S3sc1YOZETuRdW3k/pages/YgSXBGEiSsh5lwQmaiW0" %}
[Broken mention](broken://spaces/SG57S3sc1YOZETuRdW3k/pages/YgSXBGEiSsh5lwQmaiW0)
{% endcontent-ref %}

{% content-ref url="/spaces/SG57S3sc1YOZETuRdW3k/pages/6DN1AHYDIKseKwaQQeGk" %}
[Broken mention](broken://spaces/SG57S3sc1YOZETuRdW3k/pages/6DN1AHYDIKseKwaQQeGk)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.antares.id/en/api-or-http.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.