素材ライブラリ素材ライブラリ API
ガイド
実在人物素材の肖像権許諾
実在人物の QR コード読み取りセッションを作成し、収集の完了を確認します
実在人物素材の肖像権許諾
実在人物素材は、必ず本人がスマートフォンで収集と許諾を完了する必要があり、通常の画像アップロードで代用することはできません。
実在人物の QR コード読み取りセッションの作成
POST
/api/v1/materials/portrait/sessions認証方式
Authorization: Bearer <API_KEY>。
リクエストボディ · application/json
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
continuous_create | boolean | いいえ | true の場合、解析完了後に次の許諾セッションの作成を続行します |
リクエスト例
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/portrait/sessions" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"continuous_create":false}'レスポンスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
code | integer | 成功時は 0 |
msg | string | 成功時は 真人授权会话已创建 |
data.session.authorization_url | string | 許諾ページのアドレス。QR コードにして実在の人物本人に渡します |
data.session.session_token | string | セッショントークン。サーバー側にのみ保存します |
data.session.expires_in | integer | セッションの有効期間(秒) |
data.session.expire_time | string | セッションの有効期限(ISO 時間文字列) |
レスポンスボディ
{
"code": 0,
"data": {
"session": {
"authorization_url": "https://授权页面地址",
"session_token": "session-token",
"expires_in": 600,
"expire_time": "2026-09-09T08:10:00.000Z"
}
},
"msg": "真人授权会话已创建"
}session_token はログに書き込んだり、他のアカウントに送信したり、長期間保持したりしないでください。セッションの有効期限が切れたら再作成してください。
エラーレスポンス
| HTTP | msg | 説明 |
|---|---|---|
400 | 请求体必须是 JSON 对象 | リクエストボディが有効な JSON ではありません |
401 | Invalid token | API キーが欠落、誤り、または失効しています |
503 | 素材服务暂不可用 | 実在人物収集チャネルが準備できていません。リクエスト時刻を保持してからプラットフォームサポートに連絡してください |
QR コード読み取りの完了確認
POST
/api/v1/materials/portrait/resolve認証方式
Authorization: Bearer <API_KEY>。
リクエストボディ · application/json
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
session_token | string | はい | QR コード読み取りセッション作成時に返される data.session.session_token |
リクエスト例
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/portrait/resolve" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"session_token":"session-token"}'レスポンスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
code | integer | 成功時は 0 |
msg | string | 成功時は 真人授权已完成 |
data.group.id | string | 収集で生成された実在人物素材グループ ID |
data.group.name | string | グループ名 |
data.group.type | string | 固定で real |
data.group.description | string / null | グループの説明 |
レスポンスボディ
{
"code": 0,
"data": {
"group": {
"id": "group-20260911034940-lrtht",
"name": "真人素材库",
"type": "real",
"description": null
}
},
"msg": "真人授权已完成"
}解析に成功したら素材ステータスの同期を呼び出して素材一覧を照会し、実在人物素材の asset_id と status を読み取ります。
エラーレスポンス
| HTTP | msg | 説明 |
|---|---|---|
400 | 请求体必须是 JSON 对象 | リクエストボディが有効な JSON ではありません |
401 | Invalid token | API キーが欠落、誤り、または失効しています |
503 | 素材服务暂不可用 | セッションが存在しない、収集がまだ完了していない、または実在人物収集チャネルが準備できていません |
このページは役に立ちましたか?
