FJCT_ニフクラ mobile backend(mBaaS)お役立ちブログ

スマホアプリ開発にニフクラ mobile backend(mBaaS)。アプリ開発に役立つ情報をおとどけ!

mBaaSの多彩なAPIを洗い出す

f:id:mbaasdevrel:20190802215625p:plain

mBaaSはアプリと連携して使うのが前提なので、APIの塊であると言えます。多数のAPIが用意されており、機能も多様です。特にSDKを開発する際などは、APIの網羅性が重要になります。

今回はmBaaSで提供されている機能をAPIの面から紹介します。

基本

エンドポイントURLは https://mbaas.api.nifcloud.com/2013-09-01 からはじまります。

データストア

NoSQL型のデータベース機能です。

処理 HTTPメソッド エンドポイントパス 備考
データ作成 POST /classes/:className/ :className が可変
データ取得(1件) GET /classes/:className/:objectId :className と :objectId が可変
データ取得(複数件) GET /classes/:className/ where/order/limit/skipといったクエリパラメータを指定
データ更新 PUT /classes/:className/:objectId :className と :objectId が可変
データ削除 DELETE /classes/:className/:objectId :className と :objectId が可変

会員管理

認証周りの機能を提供します。

処理 HTTPメソッド エンドポイントパス 備考
会員登録 POST /users
会員登録メール要求 POST /requestMailAddressUserEntry
会員取得 GET /users/:objectId :objectId が可変
会員更新 PUT /users/:objectId :objectId が可変
会員削除 DELETE /users/:objectId :objectId が可変
ログアウト GET /logout
会員取得(複数件) GET /users/ where/order/limit/skipといったクエリパラメータを指定
パスワード再発行リクエストメール要求 POST /requestPasswordReset

ロール

権限周りの機能を実現するロールに関するAPIです。

処理 HTTPメソッド エンドポイントパス 備考
ロール作成 POST /roles
ロール取得(1件) GET /roles/:objectId :objectId が可変
ロール取得(複数件) GET /roles/ where/order/limit/skipといったクエリパラメータを指定
ロール更新 PUT /roles/:objectId :objectId が可変
ロール削除 DELETE /roles/:objectId :objectId が可変

プッシュ通知

プッシュ通知の作成、開封登録などを行います。

処理 HTTPメソッド エンドポイントパス 備考
プッシュ通知作成 POST /push
プッシュ通知取得(1件) GET /push/:objectId :objectId が可変
プッシュ通知取得(複数件) GET /push/ where/order/limit/skipといったクエリパラメータを指定
プッシュ通知更新 PUT /push/:objectId :objectId が可変
プッシュ通知削除 DELETE /push/:objectId :objectId が可変
プッシュ通知開封登録 POST /push/:objectId/openNumber :objectId が可変

デバイストークン

スマートフォンのデバイストークンを管理します。

処理 HTTPメソッド エンドポイントパス 備考
デバイストークン作成 POST /installations
デバイストークン取得(1件) GET /installations/:objectId :objectId が可変
デバイストークン取得(複数件) GET /installations/ where/order/limit/skipといったクエリパラメータを指定
デバイストークン更新 PUT /installations/:objectId :objectId が可変
デバイストークン削除 DELETE /installations/:objectId :objectId が可変

ファイルストア

ファイルストレージを提供します。

処理 HTTPメソッド エンドポイントパス 備考
ファイル登録 POST /files/:fileName :fileNameを指定
ファイル取得(1件) GET /files/:fileName :fileName が可変
ファイル取得(複数件) GET /files/ where/order/limit/skipといったクエリパラメータを指定
ファイル更新 PUT /files/:fileName :fileName が可変
ファイル削除 DELETE /files/:fileName :fileName が可変

スクリプト

スクリプトはエンドポイントのURLが異なります。

https://script.mbaas.api.nifcloud.com/2015-09-01

そして、パスは下記のようになります。:METHODは作成時に指定するHTTPメソッドです。GET/POST/PUT/DELETEのいずれかが指定できます。:fileNameはアップロードしたスクリプトのファイル名で、.jsまたは.rbという拡張子を持ちます。

:METHOD /script/:fileName

まとめ

mBaaSには多様なAPIが用意されています。機能的に見ればFacebookやTwitter認証など、さらに細分化されますが、基本的にはこれらの機能があると把握すれば良いでしょう。皆さんのアプリ開発に活かしてください!

中津川 篤司

中津川 篤司

NCMBエヴァンジェリスト。プログラマ、エンジニアとしていくつかの企業で働き、28歳のときに独立。 2004年、まだ情報が少なかったオープンソースソフトの技術ブログ「MOONGIFT」を開設し、毎日情報を発信している。2013年に法人化、ビジネスとエンジニアを結ぶDXエージェンシー「DevRel」活動をスタート。