クイックスタート(HTTP API)BETA

HTTP APIを利用することで、SDKが提供されていない言語でも管理者向けの機能にアクセスすることができます。

このページでは、HTTP APIの共通仕様を説明します。

ベースURL

ベースURLは以下の通りです。

<配布したベースURL>/api_zeus

上記の後に各APIのパスを指定してください。例えば、「プッシュ送信API」のエンドポイントURLは以下のようになります。

https://baas.raku-za.jp/apps/XXXXXX/api_zeus/push/send

サーバー認証

サーバー認証トークンをAuthorizationヘッダーに指定して、Bearer認証を行います。

Authorization: Bearer <配布したサーバー認証トークン>

ヒント

サーバー認証トークンの認証に失敗した場合、400 Bad Requestが返ります。

リクエスト

HTTPメソッドはすべてPOSTです。パラメーターはリクエストボディで渡します。

リクエストボディのContent-Typeはapplication/x-www-form-urlencodedおよびmultipart/form-dataに対応しています。

以下はmultipart/form-dataでAPIを呼び出すcURLのサンプルです。

curl --location '<配布したベースURL>/api_zeus/push/send' \
--header 'Authorization: Bearer <配布したサーバー認証トークン>' \
--form 'tenant_id="<配布したテナントID>"' \
--form 'contents[push_message]="新商品のお知らせ"'

パラメーターがネストしている場合、object[name]=valueの形式で階層を表現します。例えば、contents.search_condition.user_noは以下のように指定してください。

--form 'contents[search_condition][user_no]="APP00001"'

ステータスコード

返却されるHTTPステータスコードは以下の通りです。

200: 正常終了、入力チェックエラー等の場合（エラーの詳細はレスポンスに含まれるステータスコードを参照ください）
4xx: サーバー認証トークンの認証に失敗した場合、など
5xx: 予期しないサーバー側のエラーが発生した場合、など

APIの呼び出し側では必ずHTTPステータスコードとレスポンスに含まれるステータスコードを見て結果を判定するようにしてください。

レスポンス

レスポンスはJSONで返却されます。

すべてのレスポンスはstatus（ステータスコード）、message、contentsを含んでおり、API個別の返却値はcontentsに含まれます。

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "push_send_cnt": 100
  }
}

また、エラーの場合（ステータスコードが正常終了以外の場合）はcontents.detail_messageに詳細なエラーメッセージが設定されます。

{
  "status": "9002",
  "message": "システムエラー",
  "contents": {
    "detail_message": "不正なパラメータです。"
  }
}

エラーハンドリングの詳細はエラーハンドリングを参照ください。

# クイックスタート(HTTP API)BETA

# ベースURL

# サーバー認証

# リクエスト