FutureStandard MAKERS

東京にある映像解析プラットフォーム「SCORER」の開発をしているスタートアップのブログです

SCORERのAPIを使ってみよう

f:id:FutureStandard:20190110144112p:plain

SCORERはAPIで呼び出せます!

SCORERでは、GUIだけでなくAPIによる操作も提供しています。

現在、APIにて行える操作は下記のとおりです(順次強化予定)。

  • 登録されているフォルダー/デバイス一覧の取得
  • バイスの映像、静止画、ログのダウンロード
  • 映像に対し自動で適用されるアルゴリズム(ルール)の一覧取得
  • ルールが適用された映像、静止画、ログのダウンロード
  • 指定して実行するアルゴリズム(ジョブ)の一覧取得
  • ジョブが適用された映像、静止画、ログのダウンロード
  • 動画ファイルのフォルダーへのアップロード

 

この記事では、SCORER Cloud上に作成したフォルダーの情報を取得することで、APIの利用方法についてご紹介します。

 

 ①フォルダーの作成

まずは、SCORER Cloudにログインし、APIキーを取得します。
もしフォルダーがない場合は、先にSCORER Cloud上でフォルダーを作っておきましょう。
SCORER Cloudにログイン後「+」をクリック、表示されるメニューから「ADD FOLDER」を選択してください。

f:id:FutureStandard:20181228105652j:plain

フォルダーの作成


一覧に「Folder」という枠が追加されます。
これでフォルダーの作成は完了です。

 

APIキーの取得

SCORER Cloud画面左のメニューから「API Keys」をクリックしてください。

(メニュー配置は将来変更になる可能性があります)

 

f:id:FutureStandard:20181128192547j:plain

APIキー取得画面の呼び出し

「New Key Label」に任意の名前を入力後、「ADD KEY」をクリックするとキーが取得できます。

 

f:id:FutureStandard:20181128192923j:plain

APIキーの取得

「New Key」の文字列すべてがAPIキーとなります。文字列すべてコピーし控えておいてください。

 

f:id:FutureStandard:20181128193143j:plain

APIキーの文字列をコピー

三者にこのキーが知られてしまうと、その第三者からも、SCORERのデータにアクセスできてしまいますので、厳重に管理してください。

なお、文字列は一度しか表示されません。忘れてしまった場合はDELETEで消して、もう一度新たにAPIキーを発行してください。

 

③Postmanのインストール

今回は、Postmanというソフトを使って、APIを呼び出してみます。
Postmanを使えば、GUI上でAPIの呼び出し、結果を簡単に確認することができます。

 

    https://www.getpostman.com/

 

「Download the App」をクリックし、お使いのプラットフォーム下の「Download」をクリックするとダウンロードが始まります。

 

インストールが完了し、Postmanが起動したら、一度Postmanを終了してください。

 

APIドキュメントの呼び出し

APIを呼び出すためには事前に設定が必要なのですが、SCORERでは自動設定する仕組みを用意しています。

 

下記のサイトを開いてください。APIのドキュメントページです。

 

pub.docs.scorer.jp

 

f:id:FutureStandard:20181128193258p:plain

ドキュメントサイト。ここからPostmanが起動できます

右上の「Run in Postman」をクリックしてください。
ここからPostmanを起動すると、APIや環境が自動設定されます。

(次回以降は、普通に起動していただいて問題ありません)

 

⑤デバイス一覧取得

改めて、Postmanの画面を見てみましょう。

左側のCollectionsに「SCORER API v1.x」(v1.xは現在のAPIバージョン)と表示されていることを確認してください。ここに使用可能なAPIがあらかじめ並べられています。

 

「Devices」には登録している端末に関するAPIが、「Rules」には自動的に適用されているアルゴリズムに関するAPI(SCORER Cloudの「Rule」に対応)が、「Jobs」には手動適用のアルゴリズム(SCORER Cloudの「OnDemand」に対応)に関するAPIが並んでいます。

詳細は別途、解説する予定です。また、APIのドキュメントにも説明があります。

f:id:FutureStandard:20181128193444p:plain

Postman起動画面。ここからAPIを呼び出します

それでは、アカウントに登録されているデバイスの一覧を取得してみましょう。

「Devices」を開き「GET All Devices」を選択すると画面右に反映されます。

APIキーを指定する必要があるため、Headersをクリックします。

AuthorizationにAPIキーを入力し、「Send」を実行します。

f:id:FutureStandard:20181128193804j:plain

APIキー入力後Sendクリック。結果が返ってきます

画面下部「Body」部に、パラメータが表示されました。こちらが、APIの戻り値となります。登録したフォルダ名が存在していれば、デバイスの取得に成功しています。

 

 どのようなパラメータが返ってくるかは、ドキュメントをご確認ください。例えば「GET All Devices」は下記のように記載されています。

 

Get a list of all devices associated with your account. Use the id in the response to get to download snapshots, logs or videos. It can also be used to get rules and on demand jobs.

(訳)利用者のアカウントに関連する全てのデバイスの一覧を取得する。他のAPIで、APIレスポンス中の "id" を指定することで、スナップショットやログ、ビデオなどのダウンロードを行うことができる。

 

ここで返ってきたデバイスIDを利用して、スナップショットや動画、ログを取得するようです。

APIを用いてデータの取得ができると、その後のデータ連携の可能性が大きく広がります。ぜひご活用ください!