Knowledge Center / Website Monitoring
Website Monitoring
Website Monitoring / API / Bagaimana cara mendaftarkan API baru yang akan ...

Bagaimana cara mendaftarkan API baru yang akan dimonitor?

  1. Akses modul Web/API Monitoring → Web/API Status.

    Menu Web Status

  2. Dari halaman utama Web Status, klik tombol Add Web/API,

    Tombol Tambah API

  3. Selanjutnya akan muncul form untuk mengisi detail API yang akan dimonitor.

    Form Tambah API

  4. Isi data pada form tersebut dengan rincian sebagai berikut:

    Jenis IsianKeterangan
    NameNama dari API yang akan dimonitor.
    Interval checkRentang waktu diperiksanya status API secara berkala.
    ProbePilihan probe yang akan bertugas mengambil data dari API yang dimonitor. Jika ingin menambahkan probe baru, klik Add New Probe.
    URL/IPAlamat URL atau alamat IP dari API yang akan dimonitor. Mendukung 2 protokol, yaitu HTTP dan HTTPS.
    TagsKata kunci yang ditambahkan untuk mendeskripsikan API yang akan dimonitor. (Opsional)
    Alert ThresholdAmbang batas response time yang ditentukan untuk API yang akan dimonitor (diisi dalam satuan milisecond)
  5. Selanjutnya, tambahkan request dan kondisi response yang diharapkan (opsional) dengan rincian sebagai berikut:

    Jenis IsianKeterangan
    RequestMethodRequest method yang menunjukkan tindakan yang diinginkan untuk dilakukan terhadap API yang akan dimonitor.
    Request headersRequest header yang dapat digunakan dalam HTTP request untuk memberikan informasi tentang konteks permintaan.
    BodyData opsional yang terkait dengan request.
    UsernameUsername yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi.
    PasswordPassword yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi.
    Response CoditionStatus CodeKode status HTTP yang diharapkan keluar sebagai response dari API yang dimonitor.
    Match HeaderResponse header yang diharapkan keluar sebagai response dari API yang dimonitor.
    Match BodyData di dalam response body yang diharapkan keluar sebagai response dari API yang dimonitor.
    Keterangan: Jika Status Code, Match Header, atau Match Body yang diinputkan tidak ada di dalam response, maka status API tersebut dianggap down karena tidak sesuai dengan kondisi yang diharapkan.
  6. Klik tombol Save untuk menambahkan API baru.

Contoh Menambahkan API Baru

Basic Authentication

Sebagai contoh skenario, Anda ingin memonitor sebuah API yang menggunakan Basic Authentication setiap 1 menit sekali. Anda ingin memastikan bahwa API tersebut berjalan dengan lancar dalam arti memberikan kode respon 200. Untuk kebutuhan Authentication, Anda perlu menginputkan username dan password. Anda pun dapat menambahkan Tags untuk mendeskripsikan API yang ingin Anda monitor tersebut. Maka contoh isi form Add Web/API pada skenario ini adalah sebagai berikut:

Contoh Tambah API Contoh Tambah API Contoh Tambah API

Bearer Token Authentication

Sebagai contoh skenario, Anda ingin memonitor sebuah API yang menggunakan Bearer Token Authentication setiap 1 menit sekali. Anda ingin memastikan bahwa I tersebut berjalan dengan lancar dalam arti memberikan kode respon 200. Untuk kebutuhan I, Anda perlu menginputkan Bearer Token. Anda pun dapat menambahkan kondisi dari Response Header yang diharapkan keluar sebagai response dari API yang ingin Anda monitor tersebut pada kolom Match Header. Maka contoh isi form Add Web/API pada skenario ini adalah sebagai berikut:

Contoh Tambah API Contoh Tambah API Contoh Tambah API

Pertanyaan Anda belum terjawab?
Kami siap membantu segala kendala. Silahkan hubungi kami langsung dibawah ini :