オレンジメール API+Webhook簡易仕様書

2023年12月21日

オレンジメールエンタープライズ版のみ、ご希望の方にAPIキーの発行を行っています。
エンタープライズ版をご利用中に、APIのご利用をご希望場合には、サポートまでご連絡ください。

通常のオレンジメールプラン2000から10000ではAPIキーの発行は行っておりません。APIキー発行をご希望の場合にはオレンジメールエンタープライズ版へのアップグレードをご検討ください。

 

APIキーの発行

【サービス管理者向け】

  • アカウント(OID)毎にWebhookの使用許可フラグをON/OFFする（管理画面から制御可能。デフォルトOFF）

【ユーザー向け】

  • 使用許可フラグをONにしたのち、ユーザ自身が登録情報変更からAPIキーを発行・取得する
  1. [マイページ（登録情報変更・解約）]をクリックします。

  2. [登録情報変更・パスワード変更]をクリックします。

  3. [API情報の発行・表示]画面が表示されます。ログインパスワードを入力してください。[API情報を発行・表示]ボタンを押してください。

 

全体的な仕様

    • APIのリクエスト数は、10分間に100回までの使用制限あり
      （APIごとにではなくトータルのリクエスト数で計算）
    • APIリクエスト時の戻り値 正常終了
      　　HTTP Status：200
      　　message：OK
      異常終了
      　　HTTP Status：200以外
      　　message：エラー概要

 

OM API簡易仕様（メルマガ作成）

  • 絞込条件なしでプラン内にメルマガを作成する（配信者の絞り込みは現在未対応）
  • ステップメールは未対応
  • 置換文字の使用可能
  • クリック解析の使用可能（本文中にURLがある場合、自動的にクリック解析対象となる）

 

API実行方法

cURLを使用した場合のサンプル

※エンタープライズ版の場合、--urlは「https://smail.omee1.com/api/v0/mail/make」となる
curl \
--request POST \
--url https://mail.os7.biz/api/v0/mail/make \
--header 'Authorization: Bearer {APIKEY}' \
--header 'Content-type: application/json' \
--data '{"plan":"Oay9", "from": {"mail": "mo@orange-cloud7.net", "name":"太田APIテスト"}, "content": {"type": "text/plain","subject":"テストlink2","body": "本文１\nhttp://google.co.jp\n本文３"}, "send_time" : "2017-08-28 16:30:00"}' \
--insecure

 

各パラメータの解説

  • –request POST：リクエストメソッド：固定値
  • --url https://mail.os7.biz/api/v0/mail/make ：実行するAPIのURL
  • –header 'Authorization: Bearer {APIKEY}’：認証キー：「Authorization: Bearer 」まで固定値。{APIKEY}はAPIキーの発行を参照
  • –header 'Content-type: application/json’：リクエストヘッダ：固定値
  • –data：メルマガ作成機能に渡すパラメータ 
    {
	"plan":"Oay9",						対象プランのプランHash
	"from": {						発行者情報
		"mail": "mo@orange-cloud7.net",			発行者メールアドレス
		"name":"太田APIテスト"				発行者名
	},
	"content": {						コンテンツ情報
		"type": "text/plain",				固定値
		"subject":"APIテストlink",			件名
		"body": "本文１\nhttp://google.co.jp\n本文３"	本文(改行は\n)
	},
	"send_time" : "2017-08-28 16:30:00",			配信日時
}
  • –insecure：オプション（SSL証明書関連でエラーが出た場合に指定）

 

OM API簡易仕様（読者登録）

API実行方法

cURLを使用した場合のサンプル

※エンタープライズ版の場合、--urlは「https://smail.omee1.com/api/v0/customer/add」となる
curl \
--request POST \
--url https://mail.os7.biz/api/v0/customer/add \
--header 'Authorization: Bearer {APIKEY}' \
--header 'Content-type: application/json' \
--data '{"plan":"Oay9", "add": { "mail":"makuson2@gmail.com", "sei":"testsei", "mei":"testmei", "form_id":"API", "point":"9", "insert_date":"2018-03-05 17:01:20", "free1":"f1", "free2":"f2", "free3":"f3", "free4":"f4", "free5":"f5", "free6":"f6", "free7":"f7", "free8":"f8", "free9":"f9", "free10":"f10"} }' \
--insecure

 

各パラメータの解説

    • –request POST：リクエストメソッド：固定値
    • --url https://mail.os7.biz/api/v0/customer/add ：実行するAPIのURL
    • –header 'Authorization: Bearer {APIKEY}’：認証キー：「Authorization: Bearer 」まで固定値。{APIKEY}はAPIキーの発行を参照
    • –header 'Content-type: application/json’：リクエストヘッダ：固定値
    • –data：読者情報変更機能に渡すパラメータ
{
	"plan":"Oay9",						対象プランのプランHash
	"add": {						登録したい値（※１）
		"mail":"makuson2@gmail.com",			メールアドレス（指定必須）
		"sei":"testsei", 				姓
		"mei":"testmei",				名
		"form_id":"API",				登録経路
		"point":"9",					ポイント
		"insert_date":"2018-03-05 17:01:20",		登録日時
		"free1":"f1",					項目1
		"free2":"f2",					項目2
		"free3":"f3",					項目3
		"free4":"f4",					項目4
		"free5":"f5",					項目5
		"free6":"f6",					項目6
		"free7":"f7",					項目7
		"free8":"f8",					項目8
		"free9":"f9",					項目9
		"free10":"f10"					項目10
	}
}
  • –insecure：オプション（SSL証明書関連でエラーが出た場合に指定）
※１：読者登録の場合はメールアドレスのみ指定必須
　　　設定しない項目は指定不要

OM API簡易仕様（読者情報変更）

API実行方法

cURLを使用した場合のサンプル

※エンタープライズ版の場合、--urlは「https://smail.omee1.com/api/v0/customer/mod」となる
curl \
--request POST \
--url https://mail.os7.biz.com/api/v0/customer/mod \
--header 'Authorization: Bearer {APIKEY}' \
--header 'Content-type: application/json' \
--data '{"plan":"lhuF", "mail":"makuson2@gmail.com", "mod": {"mail":"makuson2+aaa@gmail.com", "sei":"testsei", "mei":"testmei"}}' \
--insecure

 

各パラメータの解説

    • –request POST：リクエストメソッド：固定値
    • --url https://mail.os7.biz/api/v0/customer/mod ：実行するAPIのURL
    • –header 'Authorization: Bearer {APIKEY}’：認証キー：「Authorization: Bearer 」まで固定値。{APIKEY}はAPIキーの発行を参照
    • –header 'Content-type: application/json’：リクエストヘッダ：固定値
    • –data：読者情報変更機能に渡すパラメータ
{
	"plan":"lhuF",					対象プランのプランHash
	"mail":"makuson2+aaa@gmail.com",	 	変更対象読者のメールアドレス
	"mod": {					変更したい値（※）
		"mail":"makuson2+20180219@gmail.com",	メールアドレス
		"sei":"testsei", 				姓
		"mei":"testsei"					名
　　　　　　		　　※以下、読者登録と同様の項目を変更可能
	}
}
  • –insecure：オプション（SSL証明書関連でエラーが出た場合に指定）
※：変更対象の項目を最低ひとつは指定必須
　　　変更したい項目のみを指定すればよく、変更しない項目は指定不要

OM API簡易仕様（読者解除）

API実行方法

cURLを使用した場合のサンプル

※エンタープライズ版の場合、--urlは「https://smail.omee1.com/api/v0/customer/del」となる
curl \
--request POST \
--url https://mail.os7.biz/api/v0/customer/del \
--header 'Authorization: Bearer {APIKEY}' \
--header 'Content-type: application/json' \
--data '{"plan":"Oay9", "mail":"makuson2@gmail.com"}' \
--insecure

 

各パラメータの解説

    • –request POST：リクエストメソッド：固定値
    • --url https://mail.os7.biz/api/v0/customer/del ：実行するAPIのURL
    • –header 'Authorization: Bearer {APIKEY}’：認証キー：「Authorization: Bearer 」まで固定値。{APIKEY}はAPIキーの発行を参照
    • –header 'Content-type: application/json’：リクエストヘッダ：固定値
    • –data：読者解除機能に渡すパラメータ
{
	"plan":"Oay9",				対象プランのプランHash
	"mail":"makuson2@gmail.com", 		解除対象読者のメールアドレス
}
  • –insecure：オプション（SSL証明書関連でエラーが出た場合に指定）

プランHashの指定方法

下記図の赤枠のプランメニューの末尾4ケタの文字列

OM Webhook簡易仕様

基本仕様はSendGridに準拠 https://sendgrid.kke.co.jp/docs/API_Reference/
　http://blaynmail.jp/api/list.html
　https://www.jcity.co.jp/mmg/functionDetail.php?t=interlock_outside
※Web API http://qiita.com/xuj/items/7e9501f91df9eb9e23bf

【サービス管理者】

  • アカウント(OID)毎にWebhookの使用許可フラグをON/OFFする（管理画面から制御可能。デフォルトOFF）

【ユーザー向け】

  • プラン毎に通知するEmail Activityをユーザが設定する
  • 通知対象Email Activityは、Processed（配信）、Delivered（受信）、Bounce（受信拒否）、Dropped（配信失敗）
  1. [プラン設定]＞[webhook設定]をクリックします。
  2. [Webhook設定]の画面が表示されます。
  • リアルタイムではなく、現状1分に1回実行される
  • POSTのリトライ処理はない
  • JSON形式でPOSTする
  • 1イベントの中身は以下の通り 
    　event：Processed、Delivered、Bounce、Droppedのいずれか
　hash：プランHash
　email：配信先メールアドレス
　time：イベント発生時刻
　id：一連イベントごとの固有ID（Processedとそのあとに発生する Delivered は同じIDになる）
  • サンプル 
    [	{"event":"Processed","hash":"zxS9","email":"bounce@test5oc.xyz","time":"2017-08-25 14:52:03","id":"34225"},
	{"event":"Delivered","hash":"zxS9","email":"test00100@test4oc.com","time":"2017-08-21 17:19:20","id":"34212"}
]
  • 一回のPOSTで送信される最大イベント数は3000くらい（それ以上取得できた場合もそのまま送るため曖昧）
  • 制限事項
    • deliveredのあとにBounceが発生する場合がありうる
    • BounceとDeliveredのタイムスタンプが逆になる場合がある（BounceしたあとにDeliveredが発生する）

オレンジメール, メルマガ, 読者管理, マイページ

Posted by オレンジスピリッツ

お問い合わせは、お問い合わせフォームよりお願いいたします。

記事はいかがだったでしょうか？
ご意見・ご感想をお聞かせください




Powered by このフォームは『オレンジフォーム』で作成しています

本フォームに入力いただいた内容に対する個別の返答はできかねます。
返答が必要な場合は、お問い合わせフォームよりお願いいたします。