# OKAERI

> OKAERI（オカエリ）は、フォームの入力途中で離れた見込み客に SMS とメールで再アプローチするマーケティング SaaS。公開 API（REST・JSON）で、リード・配信・レポートの取得、除外リストの登録、キャンペーン・シナリオ・文面の下書きの作成、Webhook の送信先の管理ができる。

API のベース URL は https://api.okaeri.tech/api/v1。認証は API キー（Authorization: Bearer）。書き込みを試す時はテストキー（okr_test_）を使う（ドライラン＝保存しない）。各操作に必要なスコープは OpenAPI の x-okaeri-scopes にある。

## 開発者向けドキュメント

- [概要](https://okaeri.tech/developers/index.md): 認証とスコープ・レート制限・ドライラン・Idempotency-Key・エラーの形・Webhook と署名の検証・契約の範囲・curl のクイックスタート
- [API リファレンス（目次）](https://okaeri.tech/developers/reference/index.md): タグごとの操作の一覧と読み方
- [API リファレンス：サイト](https://okaeri.tech/developers/reference/sites.md): listSites, getSite, testSiteUrlRules, getSiteTagConfig, listSitePpChecks, getSitePpCheck
- [API リファレンス：同意の設定](https://okaeri.tech/developers/reference/consent-settings.md): getConsentSettings
- [API リファレンス：キャンペーン](https://okaeri.tech/developers/reference/campaigns.md): listCampaigns, createCampaign, getCampaign, updateCampaign, replaceCampaignUrlRules, replaceCampaignFormProfile, duplicateCampaign
- [API リファレンス：シナリオ](https://okaeri.tech/developers/reference/scenarios.md): listCampaignScenarios, createCampaignScenario, getScenario, updateScenario, deleteScenario, replaceScenarioSteps, listScenarioPresets, createCampaignScenarioFromPreset, duplicateScenario
- [API リファレンス：文面](https://okaeri.tech/developers/reference/messages.md): listMessages, createMessage, getMessage, updateMessage, deleteMessage, duplicateMessage, listMessageVariables, listMessageExamples, previewMessage, estimateSmsSegments
- [API リファレンス：リード](https://okaeri.tech/developers/reference/leads.md): listLeads, getLead
- [API リファレンス：配信](https://okaeri.tech/developers/reference/deliveries.md): listDeliveries, getDelivery
- [API リファレンス：配信スイッチ](https://okaeri.tech/developers/reference/delivery-status.md): getDeliveryStatus
- [API リファレンス：除外リスト](https://okaeri.tech/developers/reference/suppressions.md): listSuppressions, createSuppression, deleteSuppression
- [API リファレンス：レポート](https://okaeri.tech/developers/reference/reports.md): getFunnelReport, getDailyReport
- [API リファレンス：Webhook](https://okaeri.tech/developers/reference/webhooks.md): listWebhookEndpoints, createWebhookEndpoint, getWebhookEndpoint, deleteWebhookEndpoint, listWebhookEndpointDeliveries, redeliverWebhookDelivery
- [API リファレンス：スキーマ](https://okaeri.tech/developers/reference/schemas.md): リクエスト・応答・Webhook の本文の型

## 機械可読の仕様

- [OpenAPI 3.1（openapi.json）](https://api.okaeri.tech/api/v1/openapi.json): 公開 API の全操作・スキーマ・必要なスコープ。認証不要

## Optional

- [OKAERI のトップ](https://okaeri.tech/): サービスの概要
- [料金](https://okaeri.tech/pricing/): プランと月額