2015年12月10日
NEOのAPI連携機能に関連する「読者データ登録」の説明ページです。
読者データ登録のためのAPIリクエスト
読者データを、APIを利用してNEOに登録します。
APIリクエストには、まず、アクセストークンリクエストで
アクセストークンを取得する必要があります。
取得後、アクセストークンを利用してリクエストを行います。
サンプルスクリプトのダウンロードはコチラをクリックしてください。
url
services.php
method
post/get
parameter
path=userAdd
読者データ取得API 入力パラメータ
| 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
| アクセストークン | access_token | String | 必須 | – | アクセストークンはアクセストークンリクエストで取得したものです。 |
| メルマガID | magazine_id | Int | 必須 | – | 読者を登録するメルマガのID |
| メルアド | String(256) | 必須 | – | ||
| 名前 | name | String(256) | – | – | |
| 登録種別 | type | String(4-20) | – | – | 半角英数字4～20字 |
| 配信ステータス | sendstatus | Option | – | 1 | 1: 配信する 0: 配信しない |
| 顧客タイプ | user_type | Option | – | 0 | 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 | – | 0 | |
| 進捗管理 | progress | Option | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| メモ | memo | String(256) | – | – | |
| 性別 | sex | Option | – | – | 1: 男性 2: 女性 |
| 誕生日 | birthday | String | – | – | 半角数字とハイフン(yyyy-mm-dd) |
| お知らせメールの 初回配信日 | notifymail | String | – | – | 半角数字とハイフン(yyyy-mm-dd) |
| お知らせメールの 受信間隔 | notifymail_term | Int | – | 0 | 半角数字(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 | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| 属性12 | attr12 | String | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| 属性13 | attr13 | String | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| 属性14 | attr14 | String | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| 属性15 | attr15 | String | – | – | 「進捗管理、属性の選択肢管理」で設定した値（注1） |
| 登録日 | created | String | – | api経由で登録された日時 | 半角数字とハイフン(yyyy-mm-dd) |
| 登録時の完了メール | mail_send | Option | – | 1 | 0: 送信する 1: 送信しない |
| どのようにメールの配信許諾を得たか | subreason | String | 必須 | – | 特定電子メール法により、メール発行者は、各読者からどうやって配信許諾を得 たかを記録,保存しておくことが義務付けられています。 ここに配信許諾を得た方法を入力しておくと、登録から2ヶ月のあいだ、読者登録 ログに記録,保存され、あとから参照することができます。 |
注1：
例えば選択肢を10個設定している場合、0101100001のように0と1が10個並んだ文字列で指定してください。
文字列は右から選択肢1、2、3の順に並んでいて1はチェック状態を表します。
例えば選択肢1、4、5がチェック状態の場合、文字列は0000011001となります。
リクエスト例
services.php?path=userAdd& access_token=abzdfefdfggadse& magazine_id=1& email=hoge@fugo.com& subreason=api
access_token: アクセストークンリクエストで取得したものを設定してください。
レスポンス
読者データ取得API 出力パラメータ
| 項目名 | パラメーター | 型(括弧内は最大バイト数) | 備考 |
| 処理結果 | result | String | Success（固定） |
レスポンス例
{
"result": "Success"
}
エラー
リクエストが正常に処理されなかった場合、以下のような
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” } |
| 403 | 対象のデータがすでに存在している場合 | { “error”: “registered”, “error_description”: “specified reader is already registered” } |
| 405 | メルマガの設定で登録できない場合 | { “error”: “magazine_setting”, “error_description”: “specified magazine setting” } |
| 406 | 対象のメルマガが存在しない場合 | { “error”: “magazine_not_found”, “error_description”: “magazine not found” } |
| 500 | システムエラー | { “error”: “system_error”, “error_description”: “api logic error” } |
