Dokumentasi API

Overview

# Delcom Open API

> **info:** Kumpulan daftar API yang dapat digunakan sebagai pembelajaran.

---

-   [Base URL](#section-1)
-   [Format Response](#section-2)
-   [Contoh Request HTTP](#section-3)

## Base URL

`https://open-api.delcom.org/api/v1`

Nilai di atas diambil dari `APP_URL` di `.env` ditambah path `/api/v1`.

## Format Response

Setiap endpoint mengembalikan field `status` bertipe **string** dengan salah satu nilai berikut:

| `status` | Arti | Contoh kasus |
| --- | --- | --- |
| `success` | Permintaan berhasil | Data tersimpan, login berhasil |
| `fail` | Gagal karena kesalahan klien (HTTP 4xx) | Validasi gagal, data tidak ditemukan, belum autentikasi |
| `error` | Gagal karena kesalahan server (HTTP 5xx) | Kesalahan internal server |

### Response berhasil

```json
{
    "status": "success",
    "message": "Berhasil login",
    "data": {}
}
```

Field `data` hanya ada jika endpoint mengembalikan payload.

### Response gagal (klien)

```json
{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "email": [
            "The email field is required."
        ]
    }
}
```

### Response error (server)

```json
{
    "status": "error",
    "message": "Terjadi kesalahan pada server"
}
```

## Contoh Request HTTP

Setiap halaman endpoint menyertakan blok **Contoh Request** dalam format HTTP REST Client (sama seperti file `delcom.http` di root proyek).

Cara memakai `delcom.http`:

1. Buka file `delcom.http` di VS Code (ekstensi **REST Client**) atau JetBrains HTTP Client
2. Sesuaikan variabel `@BaseURL` agar sama dengan `APP_URL` + `/api/v1`
3. Jalankan request **Login** terlebih dahulu
4. Token dari response login otomatis dipakai request berikutnya melalui `@authToken`

Di contoh request, `{{BaseURL}}` mengacu ke nilai `@BaseURL` (setara Base URL di atas).

Contoh login:

```http
POST {{BaseURL}}/auth/login
Content-Type: application/json
Accept: application/json

{
    "email": "testing@delcom.org",
    "password": "123456"
}
```

Contoh request terautentikasi:

```http
GET {{BaseURL}}/todos
Authorization: Bearer <token>
Accept: application/json
```

Delcom Open API

info: Kumpulan daftar API yang dapat digunakan sebagai pembelajaran.

Base URL
Format Response
Contoh Request HTTP

Base URL

https://open-api.delcom.org/api/v1

Nilai di atas diambil dari APP_URL di .env ditambah path /api/v1.

Format Response

Setiap endpoint mengembalikan field status bertipe string dengan salah satu nilai berikut:

`status`	Arti	Contoh kasus
`success`	Permintaan berhasil	Data tersimpan, login berhasil
`fail`	Gagal karena kesalahan klien (HTTP 4xx)	Validasi gagal, data tidak ditemukan, belum autentikasi
`error`	Gagal karena kesalahan server (HTTP 5xx)	Kesalahan internal server

Response berhasil

{
    "status": "success",
    "message": "Berhasil login",
    "data": {}
}

Field data hanya ada jika endpoint mengembalikan payload.

Response gagal (klien)

{
    "status": "fail",
    "message": "Data tidak valid",
    "data": {
        "email": [
            "The email field is required."
        ]
    }
}

Response error (server)

{
    "status": "error",
    "message": "Terjadi kesalahan pada server"
}

Contoh Request HTTP

Setiap halaman endpoint menyertakan blok Contoh Request dalam format HTTP REST Client (sama seperti file delcom.http di root proyek).

Cara memakai delcom.http:

Buka file delcom.http di VS Code (ekstensi REST Client) atau JetBrains HTTP Client
Sesuaikan variabel @BaseURL agar sama dengan APP_URL + /api/v1
Jalankan request Login terlebih dahulu
Token dari response login otomatis dipakai request berikutnya melalui @authToken

Di contoh request, {{BaseURL}} mengacu ke nilai @BaseURL (setara Base URL di atas).

Contoh login:

POST {{BaseURL}}/auth/login
Content-Type: application/json
Accept: application/json

{
    "email": "testing@delcom.org",
    "password": "123456"
}

Contoh request terautentikasi:

GET {{BaseURL}}/todos
Authorization: Bearer <token>
Accept: application/json