Skip to main content

Mendapatkan Kredensial Autentikasi

Dapatkan kredensial autentikasi yang diperlukan server dan klien HappyOyster: API Host, API Key utama, API Key sementara, dan ticket.

Untuk arsitektur HappyOyster secara keseluruhan, lihat Gambaran umum.

Kredensial Autentikasi

Semua API diautentikasi melalui gateway Alibaba Cloud Model Studio. Terdapat tiga jenis kredensial:

Kredensial

Digunakan oleh

Tujuan

Masa berlaku

API Key Utama

Hanya server

Memanggil semua Open API (mengelola dunia, menukar ticket, menghasilkan API Key sementara, dan mengueri artefak)

Berlaku jangka panjang

API Key Sementara
(juga disebut token dalam SDK)

SDK Klien

Autentikasi lapisan HTTP untuk SDK (dimasukkan melalui updateToken); cukup ambil dan masukkan kembali setelah kedaluwarsa

Default 1 menit, hingga 30 menit (dikonfigurasi melalui expire_in_seconds); harus diperbarui

ticket

SDK Klien

Kredensial sekali pakai untuk masuk ke ruang; ditukar di server dan dikirimkan ke klien

30 menit, sekali pakai

Alur kredensial:
  • API Key utama hanya disimpan oleh server Anda dan tidak boleh diekspos ke klien.
  • Server Anda menggunakan API Key utama untuk menghasilkan API Key sementara dan ticket, lalu mengirimkannya ke klien.
  • Klien memasukkan API Key sementara (token) melalui updateToken. Saat kedaluwarsa, minta yang baru dari server Anda dan masukkan kembali. Anda tidak perlu menukar ulang ticket.
  • Ticket adalah kredensial masuk ruang sekali pakai yang berlaku selama 30 menit dan tidak berlaku lagi setelah digunakan. Setiap Travel baru memerlukan ticket baru.

Mendapatkan Kredensial Autentikasi

API Host dan API Key utama diperoleh dari konsol Model Studio. API Key sementara dan ticket diterbitkan oleh server Anda melalui API yang sesuai, lalu dikirimkan ke klien.
API Key utama harus tetap berada di sisi server; SDK klien hanya boleh menggunakan API Key sementara. Jangan pernah mengirimkan API Key utama ke klien atau menyertakannya dalam aplikasi yang didistribusikan.
API Host dan API Key harus berasal dari workspace yang sama; jika tidak, AccessDenied akan dikembalikan.

1. Mendapatkan API Host

Pada halaman Manajemen Workspace, salin nilai pada kolom API Host. Server Anda dan SDK klien sama-sama memerlukan API Host ini.

2. Mendapatkan API Key Utama

Lihat Mendapatkan dan mengonfigurasi API Key. API Key utama hanya boleh disimpan di server Anda; jangan kirimkan ke klien atau sertakan dalam aplikasi yang didistribusikan.

3. Mendapatkan API Key Sementara

Di server, gunakan API Key utama untuk memanggil endpoint Membuat API Key Sementara, lalu kirimkan API Key sementara yang dikembalikan ke SDK klien dan masukkan melalui updateToken. Saat kedaluwarsa, buat yang baru dan masukkan kembali. Anda tidak perlu menukar ulang ticket.

4. Mendapatkan ticket

Di server, gunakan API Key utama untuk memanggil endpoint Get Travel Credential yang sesuai dengan mode dunia Anda, dapatkan ticket masuk ruang sekali pakai, lalu kirimkan ke klien: Setiap ticket terikat satu-ke-satu dengan sebuah Travel dan dapat digunakan sekali dalam 30 menit; setiap Travel baru memerlukan ticket baru.

Langkah Berikutnya

  • Alur Integrasi: Server menyiapkan dunia, mengirimkan kredensial, dan mengambil artefak; SDK klien menangani pengalaman real-time.