# standar-desain-api

> Pedoman standar desain API untuk menjaga konsistensi, kesederhanaan, dan kemudahan perluasan Open API.

- **URL**: https://www.coohom.com/id/helpcenter/api-design-standard
- **Locale**: id_ID
- **Updated**: 2026-08-19

## Content

Standar Desain API  
Standar desain API digunakan agar Open API tetap sederhana, mudah diperluas, dan konsisten.  

Dari input hingga output, kami menetapkan beberapa batasan untuk menjaga pengalaman pengguna tetap konsisten.  

Host
====

Kecuali ada instruksi khusus, semua Open API akan di-host di [www.coohom.com](https://www.coohom.com/).  
**HTTPS** diaktifkan dalam skenario apa pun.  

Prefiks API
-----------

Kami menetapkan bahwa semua Open API dengan versi yang sama harus menggunakan prefiks API yang sama.  

Dalam definisi API, prefiks API digunakan untuk menjaga makna yang konsisten.  
![](//qhstatic-sg-s3.coohom.com/image/png/1749115660333/A8CEBABD0663ECBAEEE7516DF7A7D2B5.png)  

Field Standar
-------------

Field standar menjaga agar field yang digunakan pada entri API tetap seragam, dan kami hanya menggunakan field yang sama dalam skenario serupa.  

Empat field standar telah didefinisikan dalam dokumen **Autentikasi**, sehingga tidak dijelaskan lagi di sini.  
![](//qhstatic-sg-s3.coohom.com/image/png/1749115310978/A8CEBABD0663ECBAEEE7516DF7A7D2B5.png)  

Struktur Data Respons Standar
-----------------------------

### Struktur Data Terluar yang Diseragamkan

Semua API merespons dalam format JSON, dan struktur data terluarnya diseragamkan sebagai berikut:  
![](//qhstatic-sg-s3.coohom.com/yuntai/image/png/1749115691586/53D1F60400EA97E9BE984BE9FB4BD3C8.png)  

### Struktur Data Daftar yang Diseragamkan

Pada sebagian besar skenario saat daftar sumber daya diminta, kami menggunakan struktur data ini untuk membungkusnya.  

Struktur ini berada pada lapisan berikutnya setelah struktur data terluar dan menjadi spesifikasi untuk nilai d:  
![](//qhstatic-sg-s3.coohom.com/image/png/1749115747373/A8CEBABD0663ECBAEEE7516DF7A7D2B5.png)  

Kode Status Respons HTTP
------------------------

Umumnya, kode status respons HTTP adalah 200.  

Kesuksesan proses bisnis tertentu atau pengecualian ditunjukkan oleh field c dalam struktur data terluar yang diseragamkan.  

0 berarti sukses, sedangkan nilai lain berarti pengecualian.  

Namun, penggunaan kode status HTTP dalam kasus khusus tetap dimungkinkan, seperti pengecualian tingkat server, beberapa kesalahan framework, dan pengecualian yang belum didefinisikan.  

Saat menangani hasil respons, nilai keabsahan hasil harus dinilai berdasarkan urutan prioritas status HTTP \> nilai c.  

Semua permintaan dengan status HTTP selain 200 dianggap tidak normal, begitu juga hasil dengan nilai c != "0".  

Konvensi Parsing Struktur Data
------------------------------

Karena API akan diperbarui secara bertahap untuk mendukung lebih banyak fungsi, field baru pada data respons API akan terus ditambahkan.  

Agar server online tidak mengalami error parsing saat kami mengembalikan field data baru, siapkan kompatibilitas yang sesuai.  
Apakah ini menjawab pertanyaan Anda?