テーマ
開発者ドキュメント

APIリファレンス

Icebox APIで強力な統合を構築しましょう。メール、連絡先などにプログラムでアクセスできます。

RESTful設計

クリーンで予測可能なURLと標準HTTPメソッド

デフォルトで安全

OAuth 2.0とAPIキー認証オプション

リアルタイムWebhook

イベント発生時に即座に通知を受信

公式SDK

人気の言語とフレームワーク用ライブラリ

ベースURL
https://api.icebox.cool/v1

クイックスタート

数分でIcebox APIを使い始めましょう。

JavaScript
// Install the SDK
npm install @icebox/sdk

// Initialize the client
import { Icebox } from '@icebox/sdk';

const icebox = new Icebox({
  apiKey: 'your_api_key_here'
});

// Fetch emails from inbox
const emails = await icebox.emails.list({
  folder: 'inbox',
  limit: 10
});

console.log(emails);
cURLリクエスト
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
レスポンス
{
  "data": [
    {
      "id": "msg_abc123",
      "subject": "Welcome to Icebox",
      "from": {
        "email": "hello@icebox.cool",
        "name": "Icebox Team"
      },
      "date": "2025-01-15T10:30:00Z",
      "snippet": "Thanks for signing up...",
      "labels": ["inbox", "unread"]
    }
  ],
  "pagination": {
    "total": 156,
    "page": 1,
    "per_page": 10
  }
}

APIエンドポイント

リソース別に整理された利用可能なエンドポイントを探索します。

メール

メールメッセージの送信、受信、管理

GET/emailsすべてのメールを一覧表示
GET/emails/{id}特定のメールを取得
POST/emails新しいメールを送信
PUT/emails/{id}メールメタデータを更新
DELETE/emails/{id}メールを削除

連絡先

アドレス帳と連絡先情報の管理

GET/contactsすべての連絡先を一覧表示
GET/contacts/{id}特定の連絡先を取得
POST/contacts新しい連絡先を作成
PUT/contacts/{id}連絡先を更新
DELETE/contacts/{id}連絡先を削除

フォルダとラベル

フォルダとラベルでメールを整理

GET/foldersすべてのフォルダを一覧表示
POST/folders新しいフォルダを作成
GET/labelsすべてのラベルを一覧表示
POST/labels新しいラベルを作成

Webhook

イベントのリアルタイム通知を受信

GET/webhooksWebhookサブスクリプションを一覧表示
POST/webhooksWebhookを作成
DELETE/webhooks/{id}Webhookを削除

アカウント

アカウント設定と環境設定の管理

GET/accountアカウント詳細を取得
PUT/accountアカウント設定を更新
GET/account/usageAPI使用統計を取得

添付ファイル

メール添付ファイルのアップロードとダウンロード

GET/attachments/{id}添付ファイルをダウンロード
POST/attachments添付ファイルをアップロード
DELETE/attachments/{id}添付ファイルを削除

公式SDK

公式ライブラリを使用してより速く統合しましょう。

JavaScript / TypeScript

npm install @icebox/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

レート制限

APIレート制限はサブスクリプションティアに基づいています。

ティアレート制限日次制限
無料100リクエスト/分1,000/日
プロ1,000リクエスト/分50,000/日
ビジネス5,000リクエスト/分250,000/日
エンタープライズカスタム無制限

認証

すべてのAPIリクエストにはAPIキーまたはOAuth 2.0トークンによる認証が必要です。Authorizationヘッダーに認証情報を含めてください。

Authorization: Bearer YOUR_API_KEY

始める準備はできましたか?

APIキーを作成して、今日から統合の構築を始めましょう。