API連携
一括登録・削除
指定フォーマットのCSV形式データから読者データの一括登録・削除処理を行います。
登録方法は全登録・新規登録のみ・アップデートのみ、の3種類で行い
成功数・失敗数・失敗詳細情報がそれぞれ返ります。
削除方法はデータ削除、のみから行われ、成功数・失敗数・失敗詳細情報が返ります。
尚、登録削除でも指定フォーマットのCSVのダウンロードが必要です。
CSVで日付型をご利用いただく場合は、半角数字を続けてご入力ください。
例)2013年1月1日 → 20130101
XML-RPC
https://api.bme.jp/xmlrpc/1.0/登録用CSVデータ取得
base64 contact.importUsageCreate(string accessToken)パラメータ
| string accessToken | API利用許可トークン |
|---|
戻り値
| base64 | 登録用CSV形式データ |
|---|
削除用CSVデータ取得
base64 contact.importUsageDelete(string accessToken)パラメータ
| string accessToken | API利用許可トークン |
|---|
戻り値
| base64 | 削除用CSV形式データ |
|---|
一括登録(全登録)
struct contact.importAll(string accessToken, base64 base64Data)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| base64 base64Data | 登録用CSV形式データ |
戻り値
| struct | int success: 成功数 int failure: 失敗数 array details: エラー内容の詳細情報 int lineNumber: 行番号 string message: エラー内容 string content: 行内容 |
|---|
一括登録(新規登録のみ)
struct contact.importCreate(string accessToken, base64 base64Data)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| base64 base64Data | 登録用CSV形式データ |
戻り値
| struct | int success: 成功数 int failure: 失敗数 array details: エラー内容の詳細情報 int lineNumber: 行番号 string message: エラー内容 string content: 行内容 |
|---|
一括登録(アップデートのみ)
struct contact.importCreate(string accessToken, base64 base64Data)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| base64 base64Data | 登録用CSV形式データ |
戻り値
| struct | int success: 成功数 int failure: 失敗数 array details: エラー内容の詳細情報 int lineNumber: 行番号 string message: エラー内容 string content: 行内容 |
|---|
一括削除
struct contact.importDelete(string accessToken, base64 base64Data)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| base64 base64Data | 削除用CSV形式データ |
戻り値
| struct | int success: 成功数 int failure: 失敗数 array details: エラー内容の詳細情報 int lineNumber: 行番号 string message: エラー内容 string content: 行内容 |
|---|
一括処理エラー一覧検索
array contact.importErrorSearch(string accessToken)パラメータ
| string accessToken | API利用許可トークン |
|---|
戻り値
| array | string type: エラータイプ(登録エラー・削除エラー) dateTime.iso8601 date: 処理日時 int count: 件数 |
|---|
一括処理エラー一覧検索(日付条件)
array contact.importErrorSearchByDates(string accessToken, array createErrors, array deleteErrors)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| array createErrors | 登録エラーリスト(dateTime.iso8601) |
| array deleteErrors | 削除エラーリスト(dateTime.iso8601) |
戻り値
| array | string type: エラータイプ(登録エラー・削除エラー) dateTime.iso8601 date: 処理日時 int count: 件数 |
|---|
一括処理エラーCSV取得
base64 contact.importErrorExport(string accessToken, string type, dateTime.iso8601 date)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| string type | エラータイプ(登録エラー・削除エラー) |
| dateTime.iso8601 date | 処理日時 |
戻り値
| base64 | エラー情報のCSV形式データ |
|---|
一括処理エラー情報削除
struct contact.importErrorDelete(string accessToken, array createErrors, array deleteErrors)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| array createErrors | 登録エラーリスト(dateTime.iso8601) |
| array deleteErrors | 削除エラーリスト(dateTime.iso8601) |
戻り値
| struct | array success: 処理成功(dateTime.iso8601) array failure: 処理失敗(dateTime.iso8601) |
|---|