API連携

API機能一覧

ログイン・ログアウト

APIを利用する時の認証処理。ログインでAPI利用に必要な「access Token」を発行し継続して処理が行えるようになります。ログアウト時は、「access Token」を破棄します。
ログインAPI実行後に発行される「access Token」は最低1時間は利用可能です。発行から1時間を超えた「access Token」は順次無効化されます。
発行から1時間経過する場合は改めてログインAPIを実行し、「access Token」を取得し直すことを推奨します。
※無効になった「access Token」を利用した場合は「401 unauthorized」のエラーが返却されます

XML-RPC

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

ログイン

string authenticate.login(string username , string password , string apikey)

パラメータ

string username ブラストメールID
string password パスワード
string apikey API利用キー

戻り値

string API利用許可トークン

ログアウト

boolean authenticate.logout(string accessToken)

パラメータ

string accessToken API利用許可トークン

戻り値

boolean 処理結果
TRUE: 正常に処理が行われた
FALSE: 処理中にエラーが発生した