公開 API:概要とキー
Menuthere API を使うと、自社の POS やソフトウェアからストアを操作できます。Menuthere サポートが Orders、WhatsApp、またはその両方へのアクセス権付きのキーを作成し、ソフトウェアがそのキーでエンドポイントを呼び出します。キーでは、お店自身のデータだけを見たり変更したりできます。
- 場所
- Ask Menuthere support for a key
- プラン
- ダッシュボードでは、API キーはプランによって制限されません。WhatsApp テンプレートの送信には、つないだ WhatsApp 番号も必要で、Pro から利用できます。
- 所要時間
- 5分
- 更新日
キーを作成して管理する
ステップ 1: Menuthere サポートにキーを依頼する
API キーはまだダッシュボードにないため、Menuthere サポートが作成します。「Billing POS」など、キーの用途をサポートに伝えてください。
ステップ 2: アクセス権を選ぶ
Orders アクセスのあるキーは、注文のステータスを更新できます。WhatsApp アクセスのあるキーは、WhatsApp テンプレートを送信できます。ソフトウェアに必要なものだけを依頼してください。
ステップ 3: キーをすぐに保存する
キーは作成時に一度だけ表示されます。Menuthere は識別用のフィンガープリントしか保存しないため、あとから再表示できません。すぐにソフトウェアの設定に入れてください。紛失した場合は、サポートにキーの無効化と新しいキーの作成を依頼してください。
キーを使う
サーバーから Authorization: Bearer ck_live_… としてキーを送ります。ブラウザーのページやモバイルアプリには絶対に入れないでください。キーを読み取った人は誰でも注文を変更できてしまいます。1行の例:
curl -X POST 'https://menuthere.com/api/v1/orders/ORDER_ID/status' -H 'Authorization: Bearer ck_live_YOUR_KEY' -H 'Content-Type: application/json' -d '{"status":"accepted"}'
| エンドポイント | 必要なアクセス | ページ |
|---|---|---|
| POST /api/v1/orders/{order_id}/status | Orders | API:注文のステータスを更新する |
| GET /api/v1/whatsapp/templates | API:WhatsApp テンプレートの一覧取得と送信 | |
| POST /api/v1/whatsapp/send-template | API:WhatsApp テンプレートの一覧取得と送信 |
| ステータス | エラー | 意味 |
|---|---|---|
| 401 | missing_api_key, invalid_api_key | キーが送られていない、またはキーが間違っているか無効になっています。 |
| 403 | scope_denied | このエンドポイントに必要なアクセス権がキーにありません。 |
| 429 | rate_limited | 1分間のリクエストが多すぎます。各キーの既定は1分あたり120回です。 |
よくある質問
キーで、ほかのレストランの注文を見られますか?
キーをなくしました。もう一度表示してもらえますか?
関連ページ
見つからない場合は [email protected] までメールするか、チャットでお問い合わせください(9:00〜21:00)。ヘルプセンター料金menuthere.com
