API連携

API機能一覧

読者データの検索

登録されている読者データを検索・削除・ダウンロードが行えます。
登録時に返される識別IDやキーワードを条件として検索を行います。
対象データが無い場合には空データが返ります。

HTTP(S)

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

読者データの検索

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

パラメータ

必須 access_token API利用許可トークン
任意 f レスポンス形式を指定する。「xml」または「json」
contactIDs 識別IDリスト※[contactIDs] が指定されていなかった場合には以下のパラメータを任意項目として設定できる
keywords キーワードリスト
status 状態(配信中/配信停止/解除/削除/エラー停止)
beginError 配信エラー数(開始位置)
endError 配信エラー数(終了位置)
beginDate 新規登録日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
endDate 新規登録日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
orderBy 並べ替え対象フィールド
sortOrder 順序。ASC:昇順、DESC:降順
offset データ取得開始位置。
limit データ取得数制限。1~100まで。

レスポンスサンプル

【XMLの場合】

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

【JSONの場合】

{"contacts":[{"error":"0","status":"配信中","contactID":1,"reg_day":"20120101T00:00:00","end_day":"20120101T00:00:00","c15":"sample@blastmail.jp"}]}
contactID 識別ID
error エラー回数
status 状態(配信中・配信停止・エラー停止)
reg_day 登録日時
end_day 更新日時
c15 E-Mailアドレス

読者データの取得

URL /contact/list/export
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
任意 keywords キーワード。「,」区切りで複数指定。
status 状態(配信中/配信停止/エラー停止)。
beginError 配信エラー数(開始位置)
endError 配信エラー数(終了位置)
beginDate 新規登録日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
endDate 新規登録日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
orderBy 並べ替え対象フィールド
sortOrder 順序。ASC:昇順、DESC:降順。

レスポンスサンプル

*CSVファイルが返されます

読者データの削除

URL /contact/list/delete
HTTP Method(s) POST

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<success>1,2</success>
<failure>3</failure>
</contact>

まずは7日間、
無料でお試しください

無料で試してみる