API ini digunakan untuk mendaftarkan “MEMBERSHIP PLAN” bagi user di “KOMPAS.ID”. Apabila belum memiliki akun, maka akan sekaligus dibuatkan akun sesuai email. API ini diperuntukkan untuk partner kompas.
Mendaftarkan Membership Plan di KOMPAS.ID
Host : https://apic.kompas.id/partnership/membershipplan/register/
Methode : POST
Header Content-Type : ‘application/json’
Params :
- membership_id (integer) *
- email (varchar) *
- type (integer) *
- privatekey (varchar) *
- partner (varchar) *
Keterangan :
Symbol : *) Mandatory
Params :
- membership_id
Merupakan ID membership plan yang akan didaftarkan kepada member KOMPAS.ID. - email
Merupakan email member/user KOMPAS.ID. - type
Merupakan jenis/metode pemberian privatekey untuk partner. Nilai/value “type” adalah 1 dan 2. Penjelasan penggunaan nilai “type” ada di point privatekey. - privatekey
Jika value dari “type”= 1 :
String/kode hasil HASHING menggunakan “SHA256” dengan gabungan/ concatenation antara “salt”, “parttime”, “email”. - Pseudocode:
$salt = “9132a1be52e0528994bc345238aba3a4c545383e918f8bd4f58a58f632248b25”; //nilai salt setiap instansi/partner berbeda $parttime = gmdate('Y-m-d'); //parttime sampai date saja.Pastikan timezonenya UTC $email = “[email protected]”; //email member privatekey = hash('sha256', $salt.$parttime. $email);
Jika value dari “type”= 2 :
String/kode value dari privatekey langsung menggunakan string salt.Catatan, salt akan diinformasikan bila perjanjian kerjasama sudah ditandatangani oleh keduabelah pihak.
- partner
Merupakan kode/inisial dari partner , dimana setiap partner mempunyai kode/inisial yang berbeda.
Response API
Format response dari API adalah sebagai berikut:
{ code: "…………….(string)", message: "……………….(string)", data: { status: …….(integer [200 atau 404]) } }
Jika berhasil (berhasil mendaftarkan membership plan kepada member)
Response akan mengeluarkan “status” : 200
Contoh response:
{ code: "create new membership", message: "success to create a new membersip in kompas.id", data: { status: 200 } }
Jika tidak berhasil (tidak berhasil melakukan pendaftaran membership plan user/member).
Pemberitahuan kenapa tidak berhasil akan diinformasikan di field “message” pada respsonse .
Response akan mengeluarkan “status” : 404 (selain 200)
Contoh response:
Example 1:
{ code: "checking membership active validation", message: "membership plan's status still active", data: { status: 404 } }
Example 2:
{ code: "validation privatekey", message: "incorrect/missing value of parameter privatekey", data: { status: 404 } }