接続先
API v1の接続先は以下の通りです。
https://(ドメイン名)/tm/lpmail.php
HTTPヘッダ
HTTPプロトコルで送受信を行う場合は、HTMLヘッダが必要です。
リクエスト時には、以下の項目を設定して下さい。
| 送信方向 | 設定項目 | 設定値 | 内容 |
| リクエスト | Content-Type | application/octet-stream | データの送信においてもっとも基本的な設定値です。 他の設定値でもテキストとして認識される設定の場合は動作可能ですが、弊社サポート外となります。 |
| レスポンス | Content-Type | text/XML | レスポンスのデータ内容がテキストでXML形式であることを表します。 |
| charset | UTF-8 | レスポンスの文字コードが、UTF-8であることを表しています。 XML内にも文字コードの指定があるので、解析時はXML内の文字コードを参照してください。 |
処理シーケンス
送られてきたXMLに対し以下の順序で処理を実施します。
- 構文解析
- 認証処理
- API個別処理
- 結果出力処理
上記の処理でエラーとなった場合は、以降の処理を中断し結果出力処理を実施します。
構文解析
送られてきたXML形式の内容を解析します。解析時にエラーが発生した場合は、エラー出力を実施します。
補足説明
構文解析時には、各要素の内容の正当性等については検証しません。
認証処理
API v1を使用するためには、利用する権限が必要となります。
ユーザ認証および権限確認を実施します。
| ユーザ認証 | 以下の項目で利用可能なユーザであることを確認する。
|
| 権限確認 | 認証されたユーザに、以下の権限があるかを確認する。
|
エラーとなった場合はエラーメッセージを返します。
API個別処理
各APIにおける個別処理の部分となります。
結果出力処理
処理結果およびエラーが発生した場合、以下をレスポンスにて返します。
表示には2種類があります。
| 処理結果 (要素：result) |
指定された処理の最終的な結果について表示します。 成功時:code=0 メッセージ＝処理が正常に終了しました 失敗時:code=-1 メッセージ＝エラーが発生しました |
| エラー情報 (要素：errors) |
エラー内容について、詳細情報を表示します。 複数のエラーが発生した場合は、エラー情報を列挙して表示します。 |
