Ikhtisar REST API

Batasan Dasar

• API dirancang sesuai dengan spesifikasi HTTP dan REST. Misalnya, permintaan kueri menggunakan metode GET, sedangkan permintaan pengiriman menggunakan metode POST. Jika suatu permintaan tidak menggunakan metode HTTP yang sesuai, sistem akan mengembalikan kesalahan.
• Kecuali ditentukan lain, nilai parameter dalam permintaan harus dienkode dalam UTF-8 menggunakan URL encoding.

Pusat Data dan URL Dasar

Saat menggunakan REST API LiveDesk, gabungkan URL dasar yang dipilih dengan path API tertentu untuk mendapatkan URL permintaan yang lengkap.

              
              {base URL}/{API path}

            

Metode Autentikasi

REST API EngageLab menggunakan HTTP Basic Authentication. Tambahkan Authorization ke header HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritma untuk menghasilkan base64_auth_string adalah:

              
              base64(api_key:api_secret)

            

• Nama header adalah Authorization, dan nilainya adalah pasangan username:password yang dienkode dalam Base64, dipisahkan oleh tanda titik dua.
• Dalam konteks API LiveDesk, username adalah API Key, dan password adalah API Secret. Tambahkan sumber data bertipe API di Pengaturan Proyek > Manajemen API untuk mendapatkan API Key dan API Secret.