Video & materi

Membuat Sesi Validasi Visual

Membuat sesi validasi visual orang asli yang kompatibel dengan Volc.

POST
/api/v3

Buat sesi validasi visual orang asli sebelum mengunggah materi liveness_face yang dapat digunakan kembali. TokenLab menggunakan bentuk Volc Action API dan autentikasi Bearer TokenLab.

Gunakan organisasi, pengguna, dan ProjectName peka huruf besar-kecil (case-sensitive) yang terautentikasi sama yang membuat sesi tersebut.

Buka Result.H5Link segera setelah membuat sesi. Peluncuran awalnya dapat kedaluwarsa sebelum BytedToken 30 menit; jangan menunda untuk membukanya.

Endpoint Dan Autentikasi

POST https://api.tokenlab.sh/api/v3?Action=CreateVisualValidateSession&Version=2024-01-01
Authorization: Bearer <TOKENLAB_API_KEY>
Content-Type: application/json

Penandatanganan Volc AK/SK tidak diterima. CallbackURL wajib diisi dan harus berupa URL HTTPS publik. ProjectName bersifat opsional dan secara default bernilai default.

Alur

  1. Simpan Result.BytedToken dan buka Result.H5Link untuk orang yang diverifikasi.
  2. Untuk memilih bahasa H5, tambahkan lng ke H5Link, contohnya &lng=en. Bahasa bukan merupakan field request-body.
  3. Setelah alur H5 selesai, browser akan membuka Result.CallbackURL. Query callback dapat berisi bytedToken, resultCode, algorithmBaseRespCode, reqMeasureInfoValue, dan verify_type.
  4. Lakukan polling Mendapatkan hasil validasi visual dengan BytedToken yang disimpan hingga Result.GroupId dikembalikan.

BytedToken berlaku selama 30 menit dan dicakup untuk organisasi serta ProjectName yang terautentikasi. Tautan H5 mendukung satu autentikasi yang berhasil dan menjadi tidak valid setelah digunakan.

Perlakukan Result.H5Link sebagai URL browser yang buram (opaque): buka sebagai halaman tingkat atas, dan jangan mengurai, mendekode, menulis ulang, atau menyematkannya. TokenLab memiliki kendali atas serah terima browser dan jembatan callback.

Contoh Request

curl 'https://api.tokenlab.sh/api/v3?Action=CreateVisualValidateSession&Version=2024-01-01' \
  -H "Authorization: Bearer $TOKENLAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"CallbackURL":"https://yourapp.example.com/seedance/callback","ProjectName":"default"}'

Contoh Response

{
  "ResponseMetadata": {
    "RequestId": "req_abc123",
    "Action": "CreateVisualValidateSession",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "BytedToken": "ZXhhbXBsZS10b2tlbg",
    "H5Link": "https://api.tokenlab.sh/api/v3/visual-validation/sessions/svv_example/h5?Version=2024-01-01",
    "CallbackURL": "https://yourapp.example.com/seedance/callback"
  }
}

Percobaan Ulang yang Aman

Kirim header Idempotency-Key opsional (1–255 karakter) agar respons yang hilang dapat dipulihkan. Percobaan ulang dengan kunci, API key, CallbackURL, dan ProjectName yang sama akan mengembalikan BytedToken dan H5Link yang sama. Kunci yang sama dengan request berbeda akan mengembalikan 409 IdempotencyConflict. Saat request pertama masih dalam proses pembuatan, responsnya adalah 409 RequestInProgress dengan Retry-After: 2. Kunci yang tidak valid akan mengembalikan 400 InvalidParameter.

Error

Error menggunakan amplop tingkat atas yang sama. Baca ResponseMetadata.Error.Code dan ResponseMetadata.Error.Message alih-alih mengharapkan field dari API /v1 TokenLab lainnya.

StatusKodePenyebab
400InvalidParameterCallbackURL hilang atau tidak valid (harus berupa URL HTTPS publik tanpa kredensial), Idempotency-Key tidak valid, atau field tidak dikenal
400InvalidVersionVersion bukan 2024-01-01
405MethodNotAllowedAction hanya menerima POST
409IdempotencyConflict, RequestInProgressLihat Percobaan Ulang yang Aman
503ServiceUnavailableValidasi orang asli tidak tersedia untuk akun ini atau gagal; coba lagi nanti
curl -X POST "https://example.com/api/v3" \  -H "Content-Type: application/json" \  -d '{    "CallbackURL": "http://example.com"  }'
{  "id": "string"}

Otorisasi

BearerAuth
AuthorizationBearer <token>

Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.

Lokasi: header

Parameter query

Action?string

Nilai yang tersedia

  • "CreateContentsGenerationsTasks"
  • "GetContentsGenerationsTask"
  • "ListContentsGenerationsTasks"
  • "DeleteContentsGenerationsTasks"
  • "CreateVisualValidateSession"
  • "GetVisualValidateResult"
  • "CreateAssetGroup"
  • "ListAssetGroups"
  • "GetAssetGroup"
  • "UpdateAssetGroup"
  • "DeleteAssetGroup"
  • "CreateAsset"
  • "ListAssets"
  • "GetAsset"
  • "UpdateAsset"
  • "DeleteAsset"
Version?string
bawaan"2024-01-01"

Header

X-TokenLab-Delivery-Policy?string

Kebijakan Pengiriman per-permintaan. Menggantikan default API key dan Workspace. Secara otomatis mencoba TokenLab Verified terlebih dahulu dan dapat beralih satu kali ke Official saja sebelum output, penerimaan permintaan, atau pembuatan sumber daya persisten.

Nilai yang tersedia

  • "auto"
  • "verified"
  • "official"

Body permintaan

application/json

Respons

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json