3お名前.com メールマーケティング
読者情報 API リファレンス
第 23 版
2019/02/25
GMO インターネット株式会社

1目次

1. API の呼び出しと応答 ....................................................................................... 3
1.1. リクエスト ............................................................................................................................ 3
1.2. レスポンス........................................................................................................................... 3
2. 利用例 .......................................................................................................... 4
2.1

POST................................................................................................................................ 4

3. リファレンス.................................................................................................. 5
3.1
3.2
3.3
3.4

RegisterReaders – 読者一括登録・更新 ......................................................................... 5
DeleteAllReaders – 読者一括削除 .................................................................................. 6
TaskStatus – 処理ステータス照会 ................................................................................ 7DownloadAllReaders – 読者一覧取得 ............................................................................ 82

1. API の呼び出しと応答
1.1. リクエスト
下記の URL にパラメータを送信すること API の呼び出しを行います。
URL:

https://API サーバ/[エンドポイント名]/[コマンド名]

HTTP: 1.1 推奨
メソッド: POST

リクエスト時（POST）の Content-Type は、指定がない場合は次のとおりです；
Content-Type: application/x-www-form-urlencoded; charset=utf-8

各パラメータは基本的に重複して指定できません。

1.2. レスポンス
API は、次の様な HTTP レスポンスヘッダを返します。
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Fri, 26 Sep 2014 07:57:52 GMT

また、HTTP レスポンスボディは、次の様に JSON 形式で返送します。実際のデータは、改行や字下げは行われません。

{"Status": "SUCCESS","Data": {"ContractId": 9,"UserId": "77278872","Password": "vM#/[*#:","ServiceStatus": 1}}

レスポンスの Status プロパティと Data プロパティは共通項目です。
Status プロパティは"SUCCESS"または"FAILURE"のいずれかの値が設定されます。Data プロパティは、リクエストおよびStatus プロパティに応じて様々な値が設定されます。

3

2. 利用例

2.1 POST▼リクエスト URL① https://client.maildeliver.jp/v1.0/api/TaskStatus② https://client3.maildeliver.jp/v1.0/api/TaskStatus※お客様のご利用環境に合わせて、リクエスト URL（①または②）をご選択ください。
お客様のご利用環境はコントロールパネルの URL からご確認いただけます。
※パラメータ値はＵＲＬエンコードする必要があります。

▼リクエスト BODY
contractId=123456&password=apipassword&taskId=789

4

3. リファレンス

3.1 RegisterReaders – 読者一括登録・更新（ア）概要
読者を一括登録・更新します。読者が登録済みの場合、主キーが一致する読者情報は上書きされます。
処理は非同期に行われるため、リクエストのデータ転送が完了するとすぐに応答を返します。
メールアドレスが指定された場合は、処理結果をメールアドレスに送信します。

（イ）URL① https://client.maildeliver.jp/v1.0/api/registerReaders/register② https://client3.maildeliver.jp/v1.0/api/registerReaders/register※お客様のご利用環境に合わせて、リクエスト URL（①または②）をご選択ください。
お客様のご利用環境はコントロールパネルの URL からご確認いただけます。

（ウ）Method
POST、enctype=multipart/form-data（エ）パラメータ
ParameterNamre

Description

RequireType

MinLength

MaxLength

contractId

契約者 API ID

Yes

0-9a-zA-Z

1128

password

契約者 API パスワード

Yes

0-9a-zA-Z、記号1128

userCsv

読者情報 CSVYes

CSV ファイル

mailAddress

結果通知用メールアドレス

No

文字列

0256

listId

読者リストＩＤ

No

0-9

1128

MinValue

MaxValue※userCsv は MS932 (Shift_JIS) を使用してください※listId は、読者リスト一覧取得コマンドにより取得（オ）レスポンス
ParameterName

Description

taskId

処理状況を問い合わせる際に使用する ID を返します。

■補足
失敗時は、ErrorCode, Message を返送します。

5

3.2 DeleteAllReaders – 読者一括削除（ア）概要
読者情報を一括削除します。
処理は非同期に行われるため、リクエストのデータ転送が完了するとすぐに応答を返します。
メールアドレスが指定された場合は、処理結果をメールアドレスに送信します。

（イ）URL① https://client.maildeliver.jp/v1.0/api/deleteAllReaders/delete② https://client3.maildeliver.jp/v1.0/api/deleteAllReaders/delete※お客様のご利用環境に合わせて、リクエスト URL（①または②）をご選択ください。
お客様のご利用環境はコントロールパネルの URL からご確認いただけます。

（ウ）MethodPOST（エ）パラメータ
ParameterNamre

Description

RequireType

MinLength

MaxLength

contractId

契約者 API ID

Yes

0-9a-zA-Z

1128

password

契約者 API パスワード

Yes

0-9a-zA-Z、記号1128

mailAddress

結果通知用メールアドレス

No

文字列0256

listId

読者リストＩＤ

No0-9

1128

MinValue

MaxValue※listId は、読者リスト一覧取得コマンドにより取得（オ）レスポンス
ParameterName

Description

taskId

処理状況を問い合わせる際に使用する ID を返します。

■補足
失敗時は、ErrorCode, Message を返送します。

6

3.3 TaskStatus –処理ステータス照会（ア）概要
非同期処理の処理ステータスを照会します。

（イ）URL① https://client.maildeliver.jp/v1.0/api/taskStatus/② https://client3.maildeliver.jp/v1.0/api/taskStatus/※お客様のご利用環境に合わせて、リクエスト URL（①または②）をご選択ください。
お客様のご利用環境はコントロールパネルの URL からご確認いただけます。

（ウ）MethodPOST（エ）パラメータ
ParameterNamreDescription

RequireType

MinLength

MaxLength

contractId

契約者 API ID

Yes

0-9a-zA-Z

1128

password

契約者 API パスワード

Yes

0-9a-zA-Z、記号1128

taskIdタスク IDYes

0-9 (整数)

110

MinValue

MaxValue

19999999999（オ）レスポンス
ParameterName

Description

taskStatus

処理状況（0: 処理待ち、1: 処理中、2: 正常終了、3: エラー）

■補足
失敗時は、ErrorCode, Message を返送します。

7

3.4 DownloadAllReaders – 読者一覧取得（ア）概要
すべての読者情報を CSV 形式でダウンロードします。

（イ）URL① https://client.maildeliver.jp/v1.0/api/downloadAllReaders/② https://client3.maildeliver.jp/v1.0/api/downloadAllReaders/※お客様のご利用環境に合わせて、リクエスト URL（①または②）をご選択ください。
お客様のご利用環境はコントロールパネルの URL からご確認いただけます。

（ウ）MethodPOST（エ）パラメータ
ParameterNamre

Description

RequireType

MinLength

MaxLength

contractId

契約者 API ID

Yes

0-9a-zA-Z

1128

password

契約者 API パスワード

Yes

0-9a-zA-Z、記号1128

listId

読者リスト ID

No

0-9

1128

MinValue

MaxValue※listId は、読者リスト一覧取得コマンドにより取得■補足
失敗時は、ErrorCode, Message を返送します。

8