API連携

API機能一覧

個別登録

読者データの個別登録・検索・編集を行います。登録を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

-1: パラメータ不正
-2: 登録上限
-3: アドレス重複
0: 登録処理に失敗

XML-RPC

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

個別登録

int contact.detailCreate(string accessToken, struct contact)

パラメータ

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

戻り値

int 識別ID

個別検索(識別ID)

struct contact.detailSearchByContactID(string accessToken, int contactID)

パラメータ

string accessToken API利用許可トークン
int contactID 識別ID

戻り値

struct 項目設計において利用・必須としている項目と以下の情報を含んでいます

int contactID: 識別ID
int error: エラー回数
string status: 状態(配信中・配信停止・解除・削除・エラー停止)

個別検索(E-Mail)

struct contact.detailSearchByEmail(string accessToken, string email)

パラメータ

string accessToken API利用許可トークン
string email E-Mailアドレス

戻り値

struct 項目設計において利用・必須としている項目と以下の情報を含んでいます

int contactID: 識別ID
int error: エラー回数
string status: 状態(配信中・配信停止・解除・削除・エラー停止)

個別編集

int contact.detailUpdate(string accessToken, int contactID, struct contact)

パラメータ

string accessToken API利用許可トークン
int contactID 識別ID
struct contact 項目設計において利用・必須としている項目を設定します
以下のパラメータの設定も行えます

string status: 状態(配信中・配信停止・解除・削除・エラー停止)
int error: エラー回数

戻り値

int 識別ID