読者データ取得メール配信　VPS-NEO　マニュアル・記事

2015年12月8日

NEOのAPI連携機能に関連する「読者データ取得」の説明ページです。

読者データ取得のためのAPIリクエスト

NEOの読者データを、APIを利用して取得します。

APIリクエストには、まず、アクセストークンリクエストで
アクセストークンを取得する必要があります。
取得後、アクセストークンを利用してリクエストを行います。

サンプルスクリプトのダウンロードはコチラをクリックしてください。

url
services.php

method
post/get

parameter
path=user
読者データ取得API 入力パラメータ

項目名	パラメーター	型(括弧内は最大バイト数)	必須	デフォルト	備考
アクセストークン	access_token	String	必須	–	アクセストークンはアクセストークンリクエストで取得したものです。
検索方法	search_type	Option	–	email	id:読者ID email:メルアド
検索文字列	search_text	String(256)	必須	–	読者IDやメルアドなど
メルマガID	magazine_id	Int	必須	–	読者を検索するメルマガのID

リクエスト例

services.php?path=user&
access_token=abzdfefdfggadse&
search_type=id&
search_text=123&
magazine_id=1

access_token: アクセストークンリクエストで取得したものを設定してください。

レスポンス
読者データ取得API 出力パラメータ

項目名	パラメーター	型(括弧内は最大バイト数)	備考
読者ID	id	Int
メルアド	email	String(256)
名前	name	String(256)
登録種別	type	String(4-20)	半角英数字4～20字
配信ステータス	sendstatus	Option	1: 配信する 0: 配信しない
顧客タイプ	user_type	Option	0: その他 1: 見込み客 2: 顧客 3: 優良顧客
会社名	company	String(256)
WEBサイトURL	url	String(256)
郵便番号	zip	String(50)	半角数字、ハイフン
都道府県名	pref	String(256)
住所	address	String(256)
建物名部屋番号	address2	String(256)
電話番号	tel	String(50)	半角数字、()、+、-
携帯電話番号	mobile_tel	String(50)	半角数字、()、+、-
FAX番号	fax	String(50)	半角数字、()、+、-
ポイント	point	Int
進捗管理	progress	Option	「進捗管理、属性の選択肢管理」で設定した値
メモ	memo	String(256)
性別	sex	Option	1: 男性 2: 女性
誕生日	birthday	String	半角数字とハイフン(yyyy-mm-dd)
お知らせメールの初回配信日	notifymail	String	半角数字とハイフン(yyyy-mm-dd)
お知らせメールの受信間隔	notifymail_term	Int	半角数字(0は未設定)
部署	post	String(256)
役職	official_position	String(256)
属性1	attr1	String
属性2	attr2	String
属性3	attr3	String
属性4	attr4	String
属性5	attr5	String
属性6	attr6	String
属性7	attr7	String
属性8	attr8	String
属性9	attr9	String
属性10	attr10	String
属性11	attr11	String	「進捗管理、属性の選択肢管理」で設定した値
属性12	attr12	String	「進捗管理、属性の選択肢管理」で設定した値
属性13	attr13	String	「進捗管理、属性の選択肢管理」で設定した値
属性14	attr14	String	「進捗管理、属性の選択肢管理」で設定した値
属性15	attr15	String	「進捗管理、属性の選択肢管理」で設定した値
登録日	created	String	半角数字とハイフン(yyyy-mm-dd)

レスポンス例

{
    "id": 123,
    "email": "hoge@fugo.com",
    "name": "hoge fugo",
    "sendstatus": 1,
    "user_type": 0,
    "company": "",
    "url": "",
    "zip": "",
    "pref": "",
    "address": "",
    "address2": "",
    "tel": "",
    "mobile_tel": "",
    "fax": "",
    "point": 0,
    "progress": "",
    "memo": "",
    "sex": "",
    "birthday": "",
    "notifymail": "",
    "notifymail_term": 0,
    "post": "",
    "official_position": "",
    "attr1": "",
    "attr2": "",
    "attr3": "",
    "attr4": "",
    "attr5": "",
    "attr6": "",
    "attr7": "",
    "attr8": "",
    "attr9": "",
    "attr10": "",
    "attr11": "",
    "attr12": "",
    "attr13": "",
    "attr14": "",
    "attr15": "",
    "created": "2014-12-12 15:23:11:"
}

エラー
リクエストが正常に処理されなかった場合、以下のような
HTTPステータスコードとJSONがレスポンスされます。

HTTPステータスコード	説明	エラー例
400	パラメーターエラー	search_typeが正しい値でなかった場合。 { “error”: “wrong_parameter”, “error_description”: “search_type parameter is not valid” }
401	アクセストークンが期限切れの場合	{ “error”: “invalid_token”, “error_description”: “specified access token is expired” }
402	正しくないアクセストークンを指定した場合	{ “error”: “invalid_token”, “error_description”: “specify valid access token” }
404	対象のデータが存在しなかった場合	{ “error”: “not_found”, “error_description”: “not found” }
406	対象のメルマガが存在しない場合	{ “error”: “magazine_not_found”, “error_description”: “magazine not found” }
500	システムエラー	{ “error”: “system_error”, “error_description”: “api logic error” }

API連携機能へ戻る

VPS-NEO

関連記事: