インタラクティブ動画を統合するためのhihaho APIの使い方

更新日

hihaho APIは、ご利用のアプリケーションにインタラクティブ動画を統合するためのシームレスなソリューションを提供します。

ここでは、ステップを踏みながらやり方についてご紹介します。

hihaho APIの使い方

  1. はじめにAPIで認証する
  2. アップロードを開始するには、登録アップロードエンドポイントを使用する必要があります。このエンドポイントを使用すると、IDとURLが応答として提供されます。受け取ったURLは、動画ファイルをアップロードする宛先です。IDは、アップロードの状態を確認したり、アップロードに関するWebhookの更新を受け取るために使用できます。
  3. 動画ファイルをアップロードする際は、Curlコマンドを使用します。
    〈例〉
    curl --request PUT --upload-file /file_path/file_name.mp4 \

    "https://upload-s3.jwplatform.com/tL17msiU?AWSAccessKeyId=[AWSAccessKeyId]&Expires=1482770374&Signature=[Signature]"

    /file_path/file_name.mp4 の部分は実際のパスと動画ファイルの名前に変更してください。
  4. XHR または Fetch を使用して動画ファイルをアップロードする場合は、Content-Type ヘッダーが含まれていることを確認してください。ヘッダーの値は、AWS の記号と正しく一致するようにスペースにします。以下は Axios を使用した例です。

    return axios.put(response.data.url, file, {
    ...axiosConfig,
    headers: {
    'Content-Type': ' ',
    },
    onUploadProgress: (progressEvent: any) =>
    this.uploadProgress(progressEvent, file), })
  5. アップロードが完了すると、インタラクティブ動画のトランスコードとサムネイル生成処理が行われますが、動画はすぐに利用できるわけではないことに注意してください。トランスコード ステータスは、V2 - transcoding statuses エンドポイントを使用して確認できます。また、特定の動画フォルダに対してhihaho内でwebhook URLを指定することもできます。アップロードプロセスが完了すると、指定されたURLに通知が届きます。
  6. アップロードが完了すると、WebhookのPOSTリクエストが指定されたURLに送信されます。リクエストボディには以下のJSONデータが含まれます。

    〈成功した場合〉
    {
    "upload_id": 1,
    "upload_status": 7,
    "upload_successful": true,
    "video_container_id": 1,
    "video_id": 1
    }

    〈失敗した場合〉
    {
    "upload_id": 1,
    "upload_status": 11,
    "upload_successful": false,
    "video_container_id": 1,
    "video_id": null

これらの手順が完了したら、hihahoへの最初の動画のアップロードは成功です。hihaho スタジオまたはこのAPIを経由することで、すぐにインタラクティブ動画を作成することができます。

以上の説明よりももっとAPIについて知りたい方は、こちらの記事も参考にしてみてください。