API連携

API機能一覧

個別登録

読者データの個別登録・検索・編集を行います。登録を行うと、識別IDが返ります。

HTTP(S)

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

個別登録

URL /contact/detail/create
HTTP Method(s) POST

パラメータ

必須 access_token API利用許可トークン
* 項目設計において利用・必須としている項目を設定します
なお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください
以下のパラメータの設定も行えます
status: 状態(配信中・配信停止・解除・削除・エラー停止)
error: エラー回数
任意 format レスポンス形式を指定する。「xml」または「json」
* 項目設計において利用・必須としている項目を設定します
なお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください
以下のパラメータの設定も行えます
status: 状態(配信中・配信停止・解除・削除・エラー停止)
error: エラー回数

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
</contact>>

【JSONの場合】

{"contactID":1}

個別検索

URL /contact/detail/search
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
contactID or email 識別ID又はE-Mail
任意 f レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
<error>0</error>
<status>配信中</status>
<c15>sample@blastmail.jp</c15>
</contact>

【JSONの場合】

{"error":"0","status":"配信中","contactID":49,"c15":"sample@blastmail.jp"}
contactID 識別ID
error エラー回数
status 状態(配信中・配信停止・解除・削除・エラー停止)

個別編集

URL /contact/detail/update
HTTP Method(s) POST

パラメータ

必須 access_token API利用許可トークン
contactID 識別ID
任意 format レスポンス形式を指定する。「xml」または「json」
* 項目設計において利用・必須としている項目を設定します
なお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください
以下のパラメータの設定も行えます
status: 状態(配信中・配信停止・解除・削除・エラー停止)
error: エラー回数

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
</contact>

【JSONの場合】

{"contactID":1}