インジェストAPI（ビデオ）

共通処理

リクエストヘッダー

リクエストヘッダーはこちらをご確認ください。

リモートアセットのインジェスト

http(s)://でアクセスすることができる素材を指定してビデオを作成することができます。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
リクエストボディ
フィールド タイプ 説明 必要性
source_url String ビデオソースのURL(http(s)://) 必須
job_profile_id Integer ジョブプロファイル ID 必須
レスポンス
フィールド タイプ 説明
id String ジョブID
ref_id String 参照ID
name String ジョブ名
merchant_id String マーチャントID
job_profile_id String ジョブプロファイルID
media_id String メディアID
description String 説明文
encode_status Integer エンコード状態
source_type String 取得元タイプ
source_url String 取得元URL
created_at DateString 作成日時
updated_at DateString 更新日時
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
404 JOB_PROFILE_NOT_FOUND 該当するジョブプロファイルが存在しません
404 STORAGE_NOT_FOUND 該当するストレージが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

ローカルファイルのインジェスト

curlコマンドのFオプションで指定されたローカルファイルをアップロードしてエンコードすることができます。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
リクエストヘッダー
フィールド タイプ 説明 必要性
Profile-Id String ジョブプロファイルID 必須ではない(*)

※ 省略した場合はデフォルトプロファイルを使用してエンコードが行われます。

リクエストボディ
フィールド タイプ 説明 必要性
source_file Hash ビデオソースファイル名 必須

リクエスの例

curl -H 'X-Streaks-Api-Key:<api-key>' 
     -H 'Authorization:Bearer <auth-token>' 
     -H 'Profile-Id: <profile_id>' 
     -XPOST https://ovp-s-api.smartstream.ne.jp/v1/merchants/smartstream/jobs 
     -F "source_file=@smartstream.mp4"
レスポンス
フィールド タイプ 説明
id String ジョブID
ref_id String 参照ID
name String ジョブ名
merchant_id String マーチャントID
job_profile_id String ジョブプロファイルID
media_id String メディアID
description String 説明文
encode_status Integer エンコード状態
source_type String 取得元タイプ
source_url String 取得元URL
created_at DateString 作成日時
updated_at DateString 更新日時
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
404 JOB_PROFILE_NOT_FOUND 該当するジョブプロファイルが存在しません
404 STORAGE_NOT_FOUND 該当するストレージが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

IDもしくは参照IDによるジョブ情報の取得

ジョブ情報をIDまたは参照IDを指定して1件取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/:job_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/ref:ref_id
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
job_id String ジョブID ***** job_id, ref_idのいずれか必須
ref_id String 参照ID job_1
レスポンス
フィールド タイプ 説明
id String ジョブID
ref_id String 参照ID
name String ジョブ名
merchant_id String マーチャントID
job_profile_id String ジョブプロファイルID
media_id String メディアID
description String 説明文
encode_status Integer エンコード状態
source_type String 取得元タイプ
source_url String 取得元URL
created_at DateString 作成日時
updated_at DateString 更新日時
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
404 JOB_NOT_FOUND 該当するジョブが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

ジョブ情報一覧の取得

ジョブ情報を一括取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ 説明 サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
id String ジョブID
ref_id String 参照ID
name String ジョブ名
merchant_id String マーチャントID
job_profile_id String ジョブプロファイルID
media_id String メディアID
description String 説明文
encode_status Integer エンコード状態
source_type String 取得元タイプ
source_url String 取得元URL
created_at DateString 作成日時
updated_at DateString 更新日時
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
500 SERVER_ERROR 予期せぬエラーが発生しました

IDもしくは参照IDによるジョブプロファイル情報の取得

プロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/:job_profile_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/ref:ref_id
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
job_profile_id String ジョブプロファイルID ***** job_profile_id, ref_idのいずれか必須
ref_id String 参照ID job_profile_1
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String ジョブプロファイルID
ref_id String 参照ID
name String ジョブプロファイル名
description String 説明文
created_at String 作成日時
updated_at String 更新日時
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
404 JOB_PROFILE_NOT_FOUND 該当するジョブプロファイルが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

ジョブプロファイル情報一覧の取得

プロファイル情報を一括取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ 説明 サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String ジョブプロファイルID
ref_id String 参照ID
name String ジョブプロファイル名
description String 説明文
created_at String 作成日時
updated_at String 更新日時

レスポンスの例

HTTP/1.1 200 OK
{
  "count": 30,
  "job_profiles":
    [
      {<job_profile1 fields>},
      {<job_profile2 fields>},
      ...
    ]
}
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
401 UNAUTHORIZED 認証に失敗しました
500 SERVER_ERROR 予期せぬエラーが発生しました