Proses Otentikasi #
Permintaan ke API diamankan melalui token akses JWT. Token ini perlu dibuat menggunakan alur pemberian Kode Otorisasi OAuth v2.
Gambar di bawah ini memberikan garis besar proses yang terlibat dalam menghasilkan token yang diperlukan dan menjaganya tetap hidup:
Silakan lihat tautan di bawah ini untuk informasi teknis terperinci dan contoh kode alur pemberian Kode Otorisasi:
Untuk melanjutkan langkah-langkah di bawah ini, Anda memerlukan:
- Request_URL, Client_ID & Client_Secret (ini akan diberikan kepada Anda saat Anda meminta API akses)
- Login pengguna untuk ~.Dimensions.~ Portal Reseller untuk menyetujui otorisasi.
tip
Jika Anda mengalami masalah pada tahap apa pun dan memerlukan bantuan, silakan hubungi kami di [email protected] atau hubungi kami di (+1) 480 207 7920.
1. Minta Otorisasi #
Langkah pertama adalah meminta otorisasi - https://login.xarios.cloud/connect/authorize.
Membangun URL Berisi item di bawah ini:
- Client_Id: client_id diberikan saat pertama kali meminta API akses.
- Response_Type: Gunakan "kode".
- State: Berikan status yang dapat digunakan untuk mengidentifikasi pengalihan
- Redirect_URI: Ini mengatur pengalihan URL yang digunakan setelah token diterbitkan. Defaultnya adalah http://127.0.0.1:8000.
- Scope: Ini adalah daftar cakupan yang perlu disediakan saat meminta token. Ini harus diatur ke "openid offline_access orientasi".
Setelah permintaan otorisasi dibuat, Anda akan disajikan dengan layar login untuk ~.Dimensions.~ Portal Reseller.
Pengalihan URL sekarang harus diteruskan 'Kode Auth' yang dapat digunakan pada langkah 2.
Contoh Permintaan
[https://login.xarios.cloud/connect/authorize?client_id=123456& response_type=kode& Negara = 5CA75BDD30& redirect_uri=https%3A%2F%2Fexample.com%2Fauth& cakup=buka%20id%20offline_access%20onboarding](https://login.xarios.cloud/connect/authorize?client_id=123456&response_type=code&state=5ca75bd30&redirect_uri=https%3A%2F%2Fexample.com%2Fauth&scope=open%20id%20offline_access%20onboarding)
2. Minta Akses & Segarkan Token #
'Kode Auth' sekarang perlu ditukar dengan token akses dan penyegaran - https://login.xarios.cloud/connect/token.
- Access Token, digunakan untuk mengakses API fitur dan melakukan permintaan orientasi.
- Refresh Token, digunakan untuk menghasilkan token akses yang sedang berlangsung
Hal ini dapat dilakukan dengan membuat POST permintaan ke server otorisasi yang berisi untuk item berikut:
- Kode: Kode autentikasi yang dikumpulkan pada langkah 1.
- Grant_Type: Atur ke authorization_code. (Sesuai https://developer.okta.com/blog/2018/04/10/oauth-authorization-code-grant-type spesifikasi).
- Client_Id: client_id diberikan saat pertama kali meminta API akses.
- Client_Secret: client_secret diberikan saat pertama kali meminta API akses.
- Redirect_URI: Ini mengatur pengalihan URL yang digunakan setelah token diterbitkan. Defaultnya adalah http://127.0.0.1:8000.
Contoh Permintaan
POST <https://login.xarios.cloud/connect/token> HTTP/1.1
Jenis Konten: aplikasi/x-www-form-urlencoded
Durasi Konten: xx
kode = 98765 & grant_type=kode& client_id=123456& client_secret=987654321& redirect_uri=https%3A%2f%2fexample.com%2fauth
Server autentikasi memvalidasi permintaan dan merespons dengan token akses dan token refresh:
Contoh Tanggapan
{\
"access_token": "AYjcyMzY3ZDhiNmJkNTY",\
"refresh_token": "RjY2NjM5NzA2OWJjuE7c",\
"token_type": "pembawa",\
"kedaluwarsa": 5400\
}\
Pada tahap ini Anda harus memiliki token akses dan penyegaran. Token akses dapat digunakan untuk melakukan API permintaan orientasi sesuai kebutuhan.
Untuk informasi tentang penggunaan API, silakan merujuk ke API Referensi.
3. Menyegarkan Token Akses #
Masa pakai token akses diatur ke 1 jam. Setelah waktu ini, token akses baru perlu dibuat menggunakan token refresh.
Untuk menghindari pengharusan, interaksi pengguna untuk menghasilkan token akses baru, token refresh digunakan. Token refresh dapat digunakan untuk meminta token akses baru ketika token asli telah kedaluwarsa.
Hal ini dapat dilakukan dengan membuat POST ke server otorisasi yang berisi untuk item berikut (ini sama dengan langkah 2 tetapi menggunakan Segarkan Token alih-alih Kode Autentikasi):
- Refresh_Token: Koleksi refresh_token yang tersimpan di langkah 2.
- Grant_Type: Gunakan "refresh_token".
- Client_Id: client_id diberikan saat pertama kali meminta API akses.
- Client_Secret: client_secret diberikan saat pertama kali meminta API akses.
Contoh Permintaan
POST <https://login.xarios.cloud/connect/token> HTTP/1.1
Jenis Konten: aplikasi/x-www-form-urlencoded
Durasi Konten: xx
refresh_token=RjY2NjM5NzA2OWJjuE7c& grant_type=refresh_token& client_id=123456& client_secret=987654321
info
Menambahkan offline_access ke cakupan saat meminta otorisasi dalam proses langkah 1 akan menyebabkan token refresh dihasilkan bersama dengan token akses awal.
warning
Token refresh akan kedaluwarsa jika tidak digunakan untuk jangka waktu 90 hari. Waktu kedaluwarsa akan terus diatur ulang menjadi 90 hari setiap kali token refresh digunakan.
Mencabut Token #
Jika token menjadi disusupi maka token akses tidak dapat dicabut tetapi token refresh bisa. Hubungi dukungan segera jika ini terjadi atau nonaktifkan REST API melalui Portal Reseller.