REST (Web) API を利用する

Castify はライブ配信のバックエンドサービスですので、あなたのエンドユーザーに対して直接的な UI を提供しません。 Castify が提供するのは API であり、更に API の呼び出しをより行いやすくするものとして、各環境向けの SDK を提供しています。

API を呼び出してみる

まず最初に、API を呼び出してみて、どのように Castify を利用するかを試してみましょう。

  1. コンソール内の API アクセストークンの一覧 を開きます。

  2. API のアクセストークンが既にいくつか用意されていますので、[Click here to reveal] ボタンをクリックし、トークンを確認します。

  3. アクセストークンをコピーし、あなたのターミナルから、以下のコマンドを実行して下さい。$TOKEN 部分には、今コピーしたアクセストークンを入れます。

curl "https://api.castify.jp/api/v1/broadcasts.less" -H "Authorization: Bearer $TOKEN"

成功すると以下のような出力になります。

{"total":0,"values":[]}

今呼び出した API は、現在有効なライブ配信の一覧を取得することができます。 恐らく、あなたのプロジェクトではまだ誰もライブ配信を開始していないでしょうから、0件が返ってくることと思います。

API 呼び出しがエラーになる場合は、アクセストークンが正しくコピーできているかどうかをもう一度確認してください。

API について学ぶ

Castify において、配信や視聴といった SDK 上の概念は、 それぞれ BroadcastPlayback のように RESTful な API のリソースにマップされています。 あなたのアプリケーションは API を通して、これらに対し操作を行うことができます。

API リファレンスはこちら にあります。

SDK は、それらの機能を提供するために API を呼び出します。 また Web アプリケーションが Castify プラットフォームと連携し、高度な機能を実現するために呼び出すこともできます。 以下は API の特徴です。

  • Broadcast 等のエンティティの作成や参照/リスト/更新などの操作を提供する

  • API の呼び出しには、各操作に応じて適切なロールが付与されたアクセストークンが必要

開発中には、基本的に一切費用はかかりませんが、本番利用申請が完了した後は、一部の API は呼び出した回数やネットワーク転送量に応じて費用が請求されます。

詳しくは以下をご覧ください。