API連携

API機能一覧

ログイン・ログアウト

APIを利用する時の認証処理。ログインでAPI利用に必要な「access Token」を発行し継続して処理が行えるようになります。ログアウト時は、「access Token」を破棄します。

HTTP(S)

https://api.bme.jp/rest/1.0/

ログイン

URL /authenticate/login
HTTP Method(s) POST

パラメータ

必須 username ブラストメールID
password パスワード
api_key API利用キー
任意 format レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<authenticate>
<access_token>6b02e6b331ba2c06ec9d8bf51a6d1af4</access_token>
</authenticate>

【JSONの場合】

{"accessToken":"6b02e6b331ba2c06ec9d8bf51a6d1af4"}

ログアウト

URL /authenticate/logout
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
任意 f レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<authenticate>
<message>Log out</message>
</authenticate>