mBaaSお役立ちブログ

管理画面に新機能REST APIツールが追加されました!

先日の管理画面アップデートの際に追加された新しい機能が「REST APIツール」です。今回はそのREST APIの使い方を詳しく紹介します。

REST APIツールとは?

通常、mBaaSのデータを操作する場合は管理画面か各種SDKを使って行います。しかし現状、Objective-C/Java/Unity/JavaScriptのみが公式であり、他の言語でmBaaSを操作する際にはREST APIを直接操作する必要があります。

そうした時の補助になるのがREST APIツールになります。行いたい操作に合わせて項目を選ぶだけで実際にREST APIを実行し、その結果を確認できます。

APIキーを選ぶ

まず最初にAPIキーを選択します。自分で作っているアプリの中から選ぶか、直接入力もできます。

URLを入力する

次にURLを入力しますが、直接入力だけでなく、使いたい機能に合わせて選択(例えばデータストアのオブジェクト登録など)もできます。

必要なデータをセットする

選んだ機能によって入力が必要な項目は異なります。例えば登録であればクラス名を入力しなければなりません。また、コンテントとして登録するデータを入力する必要があります(フォーム入力と呼びます)。これは項目ごとに入力もできますが、JSONを用いて指定することもできます。

なお、この時フォーム入力とJSON入力を相互に切り替えることができます。

実行する

データの入力が終わったら実行するボタンを押して実際にREST APIをコールできます。そのレスポンスはREST APIツール上で確認できます。また、curlコマンドで実行する際の形も確認できますので、データの渡し方やシグネチャの状態を確認することもできます。

なお、このREST API呼び出しはAPIを消費しますのでご注意ください。

プリセットを保存する

実行する内容をプリセットとして登録しておくことができます。開発者の方がプリセットを登録し、運用担当者がデータを登録、検索すると言ったフローもできるようになります。

登録したプリセットはREST APIツールで呼び出せるようになります。

別ウィンドウ化

REST APIツールは画面の下に貼り付けておくほか、別ウィンドウに分けることもできます。画面の大きさに合わせて使いやすいスタイルを選択してください。


サーバサイドでmBaaSを操作する場合、現状ではNode.jsのみになります(非公式ではRuby、Python、PHPによる実装もあります)。そのため、多くのケースで自社システムと連携させてプッシュ通知登録などを行う場合には何らかのプログラミング言語で実装しなければならないでしょう。そうしたREST APIを扱う際の参考にご利用ください。

バックナンバー