Get OAuth URL

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Get OAuth URL
Function	API ini digunakan untuk menghasilkan URL pengalihan OAuth ke Paydia untuk memulai proses penjalinan akun di mana pengguna akan dapat mendaftar/login dari halaman Paydia
Service Code	10
Method	GET
URL	/snap/v1.0/get-auth-code
Accept	application/json
Content Type	application/json
Related Service	Registration

Request

Bagian berikut akan menjelaskan tentang parameter permintaan dalam API ini:

Request Params

Tabel berikut adalah daftar parameter permintaan dalam API ini:

Request Params Kueri

The following table is list of query param:

No	Name	Type	Length	Required	Condition	Remarks
1	redirectUrl	String	Variabel, maksimal 256 karakter	Mandatory	-	Ketika otorisasi pengguna berhasil, pengguna akan diarahkan ke URL ini
2	scopes	Array of String	Variabel, maksimal 256 karakter	Mandatory	-	Lingkup otorisasi
3	state	String	Variabel, maksimal 32 karakter	Mandatory	-	String acak untuk tujuan perlindungan CSRF
4	timestamp	String	Tetap, maksimal 25 karakter	Mandatory	-	Waktu tanggal transaksi, dalam format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta)
5	partnerId	String	Variabel, maksimal 64 karakter	Mandatory	-	Informasi ID mitra
6	externalId	String	Variabel, maksimal 64 karakter	Mandatory	-	Informasi ID eksternal
7	channelId	String	Variabel, maksimal 64 karakter	Mandatory	-	Informasi ID saluran
8	x-signature	String	Variabel	Mandatory	-	Signature akan dibuat secara otomatis dengan metode symmetricSignature atau asymmetricSignature
9	auth	String	Variabel	Opsional	Jika pilihan Signature adalah pendekatan asimetris	Mengandung Token B2B Bearer JWT, Anda mendapatkannya dari Token Akses B2B

Contoh Request

Berikut ini adalah contoh permintaan dari API ini:

GET .../snap?redirectUrl=https://web-merchant.com/&scopes=QUERY_BALANCE,PUBLIC_ID&state=6430c027-5c3f-4ddb-be74-1e3940943d4e&timestamp=2022-11-03T09:47:00+07:00&partnerId=3068cb31c7981b5c52096c3be18edb38&externalId=1667469949&channelId=12345&x-signature=fi80WfYG3fhFaPIkO4+mvBBdxKA3pxna8GNYKdgFLQAfQ587uuFzbLGRXO6A9Lvs+yvSlvJ9r+mRTCm22K65EhQKc1C3Xpo8Izc7sFasxDroYvggd4wbBKtPK/e7ZOY0NvNgglRPoMkQ+dKuiaiK6BtI6B1n6iH4XZ67ORjQ6Ho=&auth=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2Njc0Njg3NjksImV4cCI6MTY2NzQ3MjM2OX0.wGXFOE7pE1Av_AF9NfKCV6YHIELOFI2kjAkXUWfW5AY

Response

Bagian berikut akan menjelaskan tentang parameter tanggapan dalam API ini:

Request Params Kueri

The following table is list of query param:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Tetap, maksimal 7 karakter	Mandatory	-	Lihat daftar kode tanggapan
2	responseMessage	String	Variabel, maksimal 150 karakter	Mandatory	-	Lihat daftar kode tanggapan
3	state	String	Variabel, maksimal 32 karakter	Mandatory	-	String acak untuk tujuan perlindungan CSRF
4	authCode	String	Variabel, maksimal 256 karakter	Mandatory	-	auth_code diperlukan untuk mendapatkan token akses B2B2C

Contoh Tanggapan

Berikut ini adalah contoh tanggapan dari API ini:

https://web-merchant.com/?responseCode=2001000&responseMessage=Successful&authcode=e9e342a7b1d3c0cb6595f69e458f4c8cfbc4843db39dbe71677f2d812dc21110&state=45de99d8-9a9c-4fda-843f-d3ad556469e5

Kode Tanggapan dan Pesan

Berikut ini adalah tabel daftar kode tanggapan dan pesan dari API Get OAuth URL:

No	Response Code	Response Message	Remarks
1	2001000	Successful	Berhasil diproses
2	4001001	Invalid Field Format	Format tertentu tidak valid
3	4001002	Invalid Mandatory Field	Kehilangan atau format tidak valid pada bidang yang Mandatory
4	4011000	Unauthorized {reason}	Kesalahan otorisasi umum
5	4011001	Invalid Token (B2B)	Token otorisasi tidak valid, mungkin karena kedaluwarsa token untuk B2B
6	5001002	Backend system failure	Kesalahan server internal 500