API連携

API機能一覧

一括登録・削除

指定フォーマットのCSV形式データから読者データの一括登録・削除処理を行います。
登録方法は全登録・新規登録のみ・アップデートのみ、の3種類で行い
成功数・失敗数・失敗詳細情報がそれぞれ返ります。

削除方法はデータ削除、のみから行われ、成功数・失敗数・失敗詳細情報が返ります。
尚、登録削除でも指定フォーマットのCSVのダウンロードが必要です。

CSVで日付型をご利用いただく場合は、半角数字を続けてご入力ください。
例)2013年1月1日 → 20130101

HTTP(S)

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

登録・削除用CSVデータ取得

URL /contact/import/usage
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
type CSV形式(1:登録用, 2:削除用)

レスポンスサンプル

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

一括登録(全登録)

URL /contact/import/all
HTTP Method(s) POST

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"配信中","0","sample@blastmail.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

【JSONの場合】

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@blastmail.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括登録(新規登録のみ)

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

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"配信中","0","sample@blastmail.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

【JSONの場合】

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@blastmail.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括登録(アップデートのみ)

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

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"配信中","0","sample@blastmail.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

【JSONの場合】

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@blastmail.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括削除

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

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"sample@blastmail.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

【JSONの場合】

{"success":"1","failure":"1","details":{"detail":[{"content":"\"sample@blastmail\"","message":"[エラー内容]","lineNumber":3}]}}

一括処理エラー一覧検索

URL /contact/import/error/search
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
任意 f レスポンス形式を指定する。「xml」または「json」
createErrors 登録エラー。
日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定
deleteErrors 削除エラー。
日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contacts>
<contact>
<type>登録エラー</type>
<date>20120312T22:28:54</date>
<count>1</count>
</contact>
</contacts>

【JSONの場合】

{"contact":[{"count":1,"date":"20120312T22:28:54","type":"登録エラー"}]}

一括処理エラーCSV取得

URL /contact/import/error/export
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
type 「登録エラー」または「削除エラー」
date 日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

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

一括処理エラー情報削除

URL /contact/import/error/delete
HTTP Method(s) POST

パラメータ

必須 access_token API利用許可トークン
任意 f レスポンス形式を指定する。「xml」または「json」
createErrors 登録エラー。
日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定
deleteErrors 削除エラー。
日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>20120312T22:28:54</success>
<failure />
</contact>

【JSONの場合】

{"failure": "","success": "20180509T15:01:31"}

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

無料で試してみる