API 連携機能とは
メールディーラーの API を通じて、メールディーラー内のデータを操作（取得・更新・登録など）できる機能です。
≪API とは≫
Application Programming Interface の略。
ソフトウェアの機能を外部プログラムから利用可能にするためのインターフェース
（窓口）。
●API の連携プログラムについて
API を通じてデータを連携するためには、外部システム側でのプログラム開発が必要となります。
連携プログラムに関するサポートは行っておりませんので、ご了承ください。
API 機能を有効にする
メールディーラーで API 機能を有効にするための初期設定です。
【注意】
●API の利用単位について
API 機能はユーザ単位で利用可能です。
利用する場合、該当ユーザに対して事前に「API 連携」の権限を付与してください。
設定方法
1. 画面右上の「ユーザー名」＞「個人設定」をクリックする。
2. 「その他」タブをクリックする。
3. API トークンの「生成」をクリックする。
4. 「変更」をクリックする。
API を利用する
API を利用するための概要です。
●API の利用について
API を利用するにはプログラムの開発が必要になります。
API の技術的な仕様を含め、詳細はシステムの開発担当者様にご確認ください。
※連携プログラムに関するサポートは行っておりませんのでご了承ください。
共通仕様
【基本仕様】
| プロトコル | HTTPS : POST |
|---|---|
| 文字コード | UTF-8 |
| データ形式 | JSON |
【共通リクエストヘッダ（必須）】
| Content-Type | application/json |
|---|---|
| X-MD-apitoken | 生成された API トークン |
※レスポンスに関する共通仕様については、「API 連携仕様書」をご確認ください。
メール情報取得 API
メールディーラー内にあるメールデータ（アドレス情報・件名・本文など）を取得できる
API です。
利用例
| URI | https://メールディーラーサーバ名/api/v1/mail/get |
|---|---|
| 必要な権限 | API 連携 メール閲覧 コメント閲覧 ※コメント情報を取得する場合のみ |
| 取得可能な情報 | 件数 日付 メール ID To Reply-To Cc Bcc From 件名 本文 対応状況 担当者 添付 添付ファイル名 有効フラグ コメント 登録日 更新日 更新者 コメント フォルダ ラベル ゴミ箱フラグ 迷惑メールフラグ |
※API 経由でメール情報を取得しても、既読にはなりません。
※レスポンスに関する仕様については、「API 連携仕様書」をご確認ください。
メールディーラー内にある顧客情報（顧客ID・お名前など）を取得できる API です。
顧客情報取得 API
利用例
| URI | https://メールディーラーサーバ名/api/v1/cust/get |
|---|---|
| 必要な権限 | API 連携 個人情報の閲覧 顧客情報の閲覧 |
| 取得可能な情報 | 顧客ID メールアドレス お名前 フリガナ 電話番号 ユーザによって追加された顧客項目 |
※レスポンスに関する仕様については、「API 連携仕様書」をご確認ください。
顧客情報登録・更新 API
メールディーラーに顧客情報（メールアドレス・お名前など）を新規登録したり、
既に存在する顧客情報の更新ができる API です。
利用例
| URI | https://メールディーラーサーバ名/api/v1/cust/update |
|---|---|
| 必要な権限 | API 連携 個人情報の閲覧 顧客情報の登録／編集 |
| 登録・更新可能な情報 | 顧客ID メールアドレス（必須） お名前 フリガナ 電話番号 ユーザによって追加された顧客項目 |
※登録・更新の条件については、「API 連携仕様書」をご確認ください。
API への接続を制限する
API に接続可能な IP アドレスを制限することができます。
1. 画面右上「管理設定」＞「管理設定」をクリックする。
2. 「環境設定」＞「API アクセス制限の設定」をクリックする。
3. 「API アクセス制限」の「利用する」を選択する。
4. アクセスを許可する IP アドレスを入力する。
5. 「変更」をクリック。
