2015年12月10日
NEOのAPI連携機能に関連する「読者行動データ取得」の説明ページです。
読者行動データ取得のためのAPIリクエスト
NEOに登録されている読者の行動履歴のデータを取り出し、
外部システムで利用できます。
行動履歴は、読者行動データ登録API経由での登録の他に、
・NEOのクリックカウントURLをクリックしたとき
・属性変更URLで属性が変更されたとき
にもNEOのデータベースに登録されます。
登録されている行動履歴データは、NEOの読者管理画面でも確認できます。
APIリクエストには、まず、アクセストークンリクエストで
アクセストークンを取得する必要があります。
取得後、アクセストークンを利用してリクエストを行います。
サンプルスクリプトのダウンロードはコチラをクリックしてください。
url
services.php
method
post/get
parameter
path=action
読者行動データ登録API 入力パラメータ
| 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
| アクセストークン | access_token | String | 必須 | – | アクセストークンはアクセストークンリクエストで取得したものです。 |
| メルアド | String | 必須 | – | 読者メルアド | |
| 取得数 | limit | Int | – | 10 | 0の場合はすべて |
| オフセット | offset | Int | – | 0 | データ取得の開始位置 |
| ソート | sort | Option | – | desc | desc: 新しい順 asc: 古い順 |
リクエスト例
services.php?path=action& access_token=abzdfefdfggadse& email=hoge@fugo.com
access_token: アクセストークンリクエストで取得したものを設定してください。
レスポンス
読者行動データ登録API 出力パラメータ
| 項目名 | パラメーター | 型(括弧内は最大バイト数) | 備考 |
| アクセスURL | url | String | |
| メモ | memo | String | |
| 登録日時 | created | String |
レスポンス例
{
"url": "https://www.neo-vps.com/hoge/fugo",
"memo": "",
"created": "2015-12-02 12:10:22"
}
エラー
リクエストが正常に処理されなかった場合、以下のような
HTTPステータスコードとJSONがレスポンスされます。
| HTTPステータスコード | 説明 | エラー例 |
| 400 | パラメーターエラー | emailが正しい値でなかった場合。 { “error”: “wrong_parameter”, “error_description”: “email 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” } |
| 500 | システムエラー | { “error”: “system_error”, “error_description”: “api logic error” } |
