おもひろメール API
おもひろメールの公式APIを利用して、プログラムからメールアドレスを管理できます。
認証
すべてのAPIリクエストには、API Keyが必要です。API Keyは API管理ページから発行できます。
API Keyは Authorization ヘッダーにBearerトークンとして含めて送信してください。
Authorization: Bearer om_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxエンドポイント
GET
/api/v1/pingAPI接続テスト用エンドポイント
Example Request:
curl -X GET \
'https://omohiromail.uk/api/v1/ping' \
-H 'Authorization: Bearer YOUR_API_KEY'GET
/api/v1/addressesメールアドレス一覧を取得
Example Request:
curl -X GET \
'https://omohiromail.uk/api/v1/addresses' \
-H 'Authorization: Bearer YOUR_API_KEY'POST
/api/v1/addresses新規メールアドレスを作成
Parameters:
| パラメータ | 型 |
|---|---|
| type | string |
| localPart | string |
| label | string |
Example Request:
curl -X POST \
'https://omohiromail.uk/api/v1/addresses' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"type": "random",
"label": "Shopping"
}'DELETE
/api/v1/addresses/:idメールアドレスを削除
Example Request:
curl -X DELETE \
'https://omohiromail.uk/api/v1/addresses/xxxxx-xxxxx-xxxxx' \
-H 'Authorization: Bearer YOUR_API_KEY'GET
/api/v1/messagesメール件名一覧を取得（本文は含まない）
Parameters:
| パラメータ | 型 |
|---|---|
| addressId | string |
| limit | number |
Example Request:
curl -X GET \
'https://omohiromail.uk/api/v1/messages?addressId=xxxxx&limit=10' \
-H 'Authorization: Bearer YOUR_API_KEY'GET
/api/v1/messages/:idメールの詳細内容を取得（本文含む）
Parameters:
| パラメータ | 型 |
|---|---|
| addressId | string |
Example Request:
curl -X GET \
'https://omohiromail.uk/api/v1/messages/123?addressId=xxxxx' \
-H 'Authorization: Bearer YOUR_API_KEY'レスポンス形式
すべてのAPIレスポンスは以下のJSON形式で返されます。
{
"success": true,
"data": {
// レスポンスデータ
}
}エラー時は success: false が返されます。
レート制限
現在、APIのレート制限は設定されていませんが、過度なリクエストは避けてください。 必要に応じてレート制限を導入する場合があります。