API連携

API機能一覧

ゴミ箱

ゴミ箱内の読者データを取得・編集・削除・ダウンロードが行えます。
対象データが無い場合には空データが返ります。

HTTP(S)

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

ゴミ箱の検索

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

パラメータ

必須 access_token API利用許可トークン
任意 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まで。
f レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contacts>
<contact>
<contactID>1</contactID>
<error>0</error>
<status>削除</status>
<reg_day>20120213T16:36:59</reg_day>
<end_day>20120312T13:45:29</end_day>
<c15>sample@blastmail.jp</c15>
</contact>
</contacts>

【JSONの場合】

{"contacts":[{"error":"0","status":"削除","contactID":1,"reg_day":"20120213T16:36:59","end_day":"20120312T13:45:29","c15":"sample@blastmail.jp"}]}
contactID 識別ID
error エラー回数
status 状態(解除・削除)
reg_day 登録日時
end_day 更新日時
c15 E-Mailアドレス

ゴミ箱のデータ編集

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

パラメータ

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

レスポンスサンプル

【XMLの場合】

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

【JSONの場合】

{"failure":"3,4","success":"1,2"}

ゴミ箱のCSV取得

URL /contact/trash/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/trash/delete
HTTP Method(s) POST

パラメータ

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

レスポンスサンプル

【XMLの場合】

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

【JSONの場合】

{"failure":"3,4","success":"1,2"}

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

無料で試してみる