Skip to main content
Referensi Open API Adventure

Referensi API HappyOyster-Adventure-Get Travel Credential

Server pihak ketiga menggunakan Kunci API utama untuk menukar dengan tiket berumur pendek dan sekali pakai, lalu memberikannya secara aman kepada klien. Endpoint ini hanya memvalidasi kepemilikan World, status, dan kuota; endpoint ini tidak membuat Travel.

Cakupan

Server pihak ketiga menggunakan Kunci API utama untuk menukar dengan ticket berumur pendek dan sekali pakai, lalu memberikannya secara aman kepada klien. Sebelum memanggil, konfirmasikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Prasyarat: World harus milik akun utama saat ini dan model Adventure, serta statusnya harus ready. Konfirmasikan melalui Kueri Status Pembangunan World.
  • Pemanggil: Dipanggil oleh server Anda; ticket yang dihasilkan sebaiknya hanya diberikan kepada klien yang akan segera masuk ke room.

Permintaan HTTP

  • Singapore
  • Tiongkok (Beijing)
  • AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/get-travel-credentialGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Dapatkan kredensial travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/get-travel-credential' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedWorldId": "{encryptedWorldId}"
}'
Content-Typestring(Wajib)Tipe konten permintaan. Parameter ini harus diatur ke application/json.
Authorization string (Wajib)Autentikasi API Key. Hanya API Key utama yang didukung; dimulai dengan sk-, misalnya sk-xxx. Biasanya dikonfigurasi sebagai variabel lingkungan $DASHSCOPE_API_KEY. API Key sementara (dimulai dengan st-) akan mengembalikan 403003.
Request Body
encryptedWorldId string (Wajib)ID Adventure World di bawah akun utama saat ini dengan status ready. Dikembalikan oleh Buat World.

Parameter respons

  • Penukaran berhasil
{
    "code": 0,
    "message": null,
    "data": {
        "ticket": "tk_a1b2****",
        "expiresIn": 1800,
        "encryptedWorldId": "enc_a1b2****"
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
data objectData respons. null jika gagal.

Properti

ticket stringKredensial Travel sekali pakai dengan awalan tk_. Berlaku selama 1800 detik (30 menit) dan hanya dapat berhasil digunakan satu kali.expiresIn integerMasa berlaku dalam detik, ditetapkan ke 1800 (30 menit).encryptedWorldId stringID World terenkripsi yang sesuai dengan kredensial ini.

Status prasyarat dan catatan pemanggilan

  • World harus berstatus ready.
  • ticket berlaku selama 30 menit dan hanya dapat berhasil digunakan satu kali; dapatkan yang baru setelah kedaluwarsa atau telah digunakan.
  • ticket sebaiknya hanya diberikan kepada klien yang akan segera masuk ke room, dan tidak boleh disimpan sebagai kredensial akses jangka panjang.
  • Memanggil endpoint ini tidak membuat Travel; Travel dibuat ketika proses masuk ke room berhasil.
  • Jika kuota untuk World ini belum dibeli, maka 403007 akan dikembalikan; jika konfigurasi kapasitas sementara tidak tersedia, maka 403008 akan dikembalikan.

Kode kesalahan

Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.

Langkah selanjutnya

Setelah mendapatkan ticket:
  • Masuk Travel: klien menggunakan ticket untuk membuat Travel dan mendapatkan konfigurasi RTC.
Pembuatan Gambar
  • FAQ
Video Generation
Audio
  • Pembuatan audio
Realtime API
Penyematan Teks
TokenPlan
Model production