API 連携機能とは
メールディーラーの API を通じて、メールディーラー内のデータを操作（取得・更新・登録など）できる機能です。
≪API とは≫
Application Programming Interface の略。
ソフトウェアの機能を外部プログラムから利用可能にするためのインターフェース
（窓口）。
●API の連携プログラムについて
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連携仕様書 |
|---|---|
| メール一覧取得 | API連携仕様書 |
| ラベルの付与 | API連携仕様書 |
| 担当者変更 | API連携仕様書 |
| ラベル一覧取得 | API連携仕様書 |
| メールの閲覧者情報取得 | API連携仕様書 |
| テンプレート一覧取得 | API連携仕様書 |
| テンプレートグループ一覧取得 | API連携仕様書 |
| 状態一覧取得 | API連携仕様書 |
| 添付上限取得 | API連携仕様書 |
| メール送信（※） | API連携仕様書 |
| 既読・未読更新 | API連携仕様書 |
| ゴミ箱へ移動 | API連携仕様書 |
| ゴミ箱を空にする | API連携仕様書 |
| 添付ファイル取得 | API連携仕様書 |
| メールボックス一覧取得 | API連携仕様書 |
| ユーザ一覧取得 | API連携仕様書 |
| ユーザグループ登録・編集 | API連携仕様書 |
| ラベル登録・編集 | API連携仕様書 |
| ラベル削除 | API連携仕様書 |
| ユーザグループの削除 | API連携仕様書 |
| 分類取得 | API連携仕様書 |
| フォルダ一覧取得 | API連携仕様書 |
| 楽天あんしんメルアドサービス登録/編集 | API連携仕様書 |
※メール送信APIのみ、リクエスト数の上限が10回/分となります。
API への接続を制限する
API に接続可能な IP アドレスを制限することができます。
1. 画面右上の歯車アイコン＞「管理設定」をクリックする。
2. 「環境設定」＞「API アクセス制限の設定」をクリックする。
3. 「API アクセス制限」の「利用する」を選択する。
4. アクセスを許可する IP アドレスを入力する。
5. 「変更」をクリック。