API概要
スリーメールAPIでできる事
- 配信に必要なすべてのデータの登録及びテストメールの送信
- 未配信データの一覧及び詳細の閲覧
- 配信済データの一覧及び詳細の閲覧
- 未配信データの配信キャンセル
- 配信時未達だったメールアドレスの閲覧
API利用方法について
APIの利用手順については、
- APIへ接続し必要なデータを送信
- API側で送信されたデータの処理を行い結果をXML形式で返す
- 受信したXMLの内容に沿って処理を行う
以上となります。
APIへの接続方法及び送信データのフォーマットについては、サンプルおよび詳細を参照してください。
API詳細
XML基本書式
APIから送信されるXMLの書式は、基本的に以下の通りとなります。
<?xml version="1.0" encoding="UTF-8"?> <response xmlns="urn:3hands:3mail"> <status>OK</status> <code>200</code> <message>message</message> </response>
文字コードはUTF-8。項目の詳細は、
項目名 | 詳細 |
---|---|
status | 送信されたデータの処理が正しく行われたかどうかを示します。(OKかNG) |
code | ステータスの内容を数字で表します。詳細はコード一覧をご参照ください。 |
message | codeについてのメッセージを示します。 |
となります。
結果XMLには上記以外のデータが追加される事があります。
追加される内容については、各APIの詳細をご参照ください。
連続アクセスの禁止について
集中的で連続したアクセスはお控えください。
サーバに過剰な負荷が生じ、サービスに支障をきたす恐れがあります。
とくに、本文がほぼ共通で、送り先に応じて一部変更がある場合などで、送り先アドレス1件ごとに/API/setを呼び出すことは避けてください。異なる部分のみを送信先リスト内に切り出し、差し込み機能を利用することを検討してください。
通知メールについて
メールの送信開始前および送信完了後に、Fromアドレスとして設定した宛先へ、送信通知および送信完了通知メールが送信されます。
その他注意点
APIとのデータ通信にはSSLを使用してください。
APIへ送信するデータのチェック(空文字や書式等)を必ず行ってください。
API側でもチェックは行っておりますが、通信負荷を軽減する為にご協力ください。