Rest API

Pada kartu Rest API, Anda dapat melihat data Token (authorization key). Data ini dapat Anda gunakan sebagai authorization key (token) saat Anda memanggil API tertentu, contohnya, saat Anda ingin mengirimkan pesan berkategori authentication seperti pesan OTP.

Setiap API yang ingin Anda jalankan, akan membutuhkan authorization key yang berfungsi untuk mengecek izin pengguna yang memanggil API tersebut.

Generate Token

Anda bisa mendapatkan token untuk pemanggilan API melalui App Service bagian Rest API. Silakan tekan tombol Generate Token untuk mendapatkan token baru.

Contoh Penggunaan Token - Mengirim Pesan Outbound

Base URL

Base URL adalah URL basis yang digunakan dalam API. Base URL pada API yang akan digunakan, sebagai berikut.

Base URL

https://app.maxchat.id

Untuk mengirimkan pesan outbound Anda dapat menggunakan URL berikut.

URL

https://app.maxchat.id/api/messages/push

Method API

Method API mengacu pada jenis permintaan yang Anda buat ke server. Setiap metode akan memberikan hasil yang berbeda. Pada contoh ini, metode API yang akan digunakan adalah POST.

• POST, adalah metode yang mengirim data ke server untuk menghasilkan data baru.

Contoh penggunaan method melalui postman

Body

Body adalah data-data yang akan Anda kirim. Berikut adalah body yang akan Anda temui pada API untuk mengirimkan pesan broadcast.

body

{
    "to":"628xxxxxxxxxx", //isikan dengan nomor tujuan
    "msgType": "text", //type yang tersedia: text, image, video
    "templateId": "bb2e11bd-2f4c-464b-acc0-dxxxxxxx", //template id dari template message yang telah berstatus accepted
    "values": {
        "header": { //jika template Anda tidak memiliki header, Anda dapat menghapus bagian header
            "type": "image", //tipe header
            "attachmentUrl": "https://example.com/example.png" //berikan URL untuk attachment, mohon jangan gunakan URL pada contoh ini
        },
        "body": [ //Anda dapat memberikan nilai parameter dalam atribut body
            {"index": 1, "type": "text", "text": "123456"}
            ]
            // index 1 mewakili parameter ke 1
            // type yang saat ini tersedia hanya berupa text
            // text adalah value dari parameter tersebut
    }
}

Auth/Authorization

Pada bagian Auth, Anda akan diminta untuk memasukkan authorization key (token) untuk identitas Anda sebagai Admin. Silakan copy auth key yang Anda bisa dapatkan dari Generate Token.

Jika Anda menggunakan postman, maka ubah Auth Type menjadi Bearer Token, lalu paste auth key ke dalam kolom Token.

Auth pada Postman

Namun jika Anda menggunakan Swagger, cukup klik tombol Authorize yang dapat Anda temui pada laman bagian atas, kemudian ketik kan "Bearer " lalu paste auth key dalam kolom token.

Auth pada Swagger

Response Body

Jika Anda telah mengisi data-data yang diperlukan pada bagian Body dan Auth, Anda dapat menekan tombol send (pada postman) atau execute (pada swagger).

Jika berhasil, maka Anda akan mendapatkan response berikut

Response Berhasil

{
    "meta": {
        "autoformat": true
    },
    "content": "Message sent"
}

Jika gagal, Anda akan mendapatkan pesan error yang akan serupa dengan contoh dibawah ini. Untuk mengatasi hal ini, Anda dapat melakukan generasi (generate) ulang.

Contoh Response Gagal

{
    "message": "Forbidden resource",
    "error": "Forbidden",
    "statusCode": 403
}