インジェストAPI(ビデオ)

共通処理

リクエストヘッダー

リクエストヘッダーで下記を指定します。

リクエストヘッダータイプ説明
AuthorizationStringAuthorization: Bearer access_token

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

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

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

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

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

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

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

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

リクエスの例

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"
レスポンス
フィールドタイプ説明
idStringジョブID
ref_idString参照ID
nameStringジョブ名
merchant_idStringマーチャントID
job_profile_idStringジョブプロファイルID
media_idStringメディアID
descriptionString説明文
encode_statusIntegerエンコード状態
source_typeString取得元タイプ
source_urlString取得元URL
created_atDateString作成日時
updated_atDateString更新日時
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
404JOB_PROFILE_NOT_FOUND該当するジョブプロファイルが存在しません
404STORAGE_NOT_FOUND該当するストレージが存在しません
500SERVER_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_idStringマーチャントIDnttsmc必須
job_idStringジョブID*****job_id, ref_idのいずれか必須
ref_idString参照IDjob_1
レスポンス
フィールドタイプ説明
idStringジョブID
ref_idString参照ID
nameStringジョブ名
merchant_idStringマーチャントID
job_profile_idStringジョブプロファイルID
media_idStringメディアID
descriptionString説明文
encode_statusIntegerエンコード状態
source_typeString取得元タイプ
source_urlString取得元URL
created_atDateString作成日時
updated_atDateString更新日時
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
404JOB_NOT_FOUND該当するジョブが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ジョブ情報一覧の取得

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプ説明サンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
idStringジョブID
ref_idString参照ID
nameStringジョブ名
merchant_idStringマーチャントID
job_profile_idStringジョブプロファイルID
media_idStringメディアID
descriptionString説明文
encode_statusIntegerエンコード状態
source_typeString取得元タイプ
source_urlString取得元URL
created_atDateString作成日時
updated_atDateString更新日時
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
500SERVER_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_idStringマーチャントIDnttsmc必須
job_profile_idStringジョブプロファイルID*****job_profile_id, ref_idのいずれか必須
ref_idString参照IDjob_profile_1
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringジョブプロファイルID
ref_idString参照ID
nameStringジョブプロファイル名
descriptionString説明文
created_atString作成日時
updated_atString更新日時
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
404JOB_PROFILE_NOT_FOUND該当するジョブプロファイルが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

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

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプ説明サンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringジョブプロファイルID
ref_idString参照ID
nameStringジョブプロファイル名
descriptionString説明文
created_atString作成日時
updated_atString更新日時

レスポンスの例

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