2015年12月10日
NEOのAPI連携機能に関連する「読者データ削除」の説明ページです。
読者データ削除のためのAPIリクエスト
NEOの読者データを、APIを利用して削除します。
APIリクエストには、まず、アクセストークンリクエストで
アクセストークンを取得する必要があります。
取得後、アクセストークンを利用してリクエストを行います。
サンプルスクリプトのダウンロードはコチラをクリックしてください。
url
vices.php
method
post/get
parameter
path=userDelete
読者データ取得API 入力パラメータ
| 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
| アクセストークン | access_token | String | 必須 | – | アクセストークンはアクセストークンリクエストで取得したものです。 |
| 検索方法 | search_type | Option | – | id:読者ID email:メルアド | |
| 検索文字列 | search_text | String(256) | 必須 | – | 読者IDやメルアドなど |
| メルマガID | magazine_id | Int | 必須 | – | 読者を検索するメルマガのID |
| 解除時の完了メール | mail_send | Option | – | 1 | 0: 送信する 1: 送信しない |
リクエスト例
services.php?path=userDelete& access_token=abzdfefdfggadse& magazine_id=1& search_type=email& email=hoge@fugo.com
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” } |
| 404 | 対象のデータが存在していない場合 | { “error”: “not_found”, “error_description”: “not found” } |
| 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” } |
