Endpoint REST API
Caution
Halaman demo - Ini adalah halaman demo untuk memperlihatkan fitur dokumentasi multi-tab. Konten ini hanya untuk ilustrasi.
REST API kami menyediakan endpoint untuk mengakses dan mengelola data. Semua endpoint mengembalikan data dalam format JSON.
Base URL
Semua permintaan API harus dikirim ke base URL berikut:
https://api.example.com/v1Endpoint pengguna
Ambil semua pengguna
GET /usersMengembalikan daftar seluruh pengguna. Mendukung parameter paginasi.
Parameter kueri:
| Parameter | Tipe | Deskripsi |
|---|---|---|
| page | integer | Nomor halaman (default: 1) |
| limit | integer | Jumlah record per halaman (default: 50, maks: 100) |
| sort | string | Field untuk pengurutan (misalnya, “name”, “created_at”) |
Respons:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Ambil pengguna berdasarkan ID
GET /users/{id}Mengembalikan satu pengguna berdasarkan ID.
Respons:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Endpoint produk
Ambil semua produk
GET /productsMengembalikan daftar seluruh produk. Mendukung pemfilteran dan paginasi.
Parameter kueri:
| Parameter | Tipe | Deskripsi |
|---|---|---|
| category | string | Filter berdasarkan kategori |
| min_price | number | Filter berdasarkan harga minimum |
| max_price | number | Filter berdasarkan harga maksimum |
| page | integer | Nomor halaman (default: 1) |
| limit | integer | Jumlah record per halaman (default: 50, maks: 100) |
Respons:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Penanganan kesalahan
Semua endpoint mengikuti kode status HTTP standar dan menyertakan pesan kesalahan yang rinci bila diperlukan:
| Kode status | Deskripsi |
|---|---|
| 200 | OK - Permintaan berhasil |
| 400 | Bad Request - Parameter tidak valid |
| 401 | Unauthorized - Autentikasi diperlukan |
| 403 | Forbidden - Izin tidak mencukupi |
| 404 | Not Found - Sumber daya tidak ada |
| 429 | Too Many Requests - Batas laju terlampaui |
| 500 | Internal Server Error - Terjadi kesalahan server |
Respons kesalahan menyertakan pesan yang menjelaskan penyebabnya:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}