接続

REST API

自社サービスのサーバーから REST で店舗データを取得します。同じキーで、予約リクエストや「今空いていますか?」のようなリアルタイムの問い合わせも送れます。下の 3 ステップで最初のレスポンスを受け取れます。

API キーはダッシュボードで作成します。キーの文字列は作成時に一度しか表示されないので、安全な場所に保管してください。

API キーを取得 →
  1. 01

    キーを作成

    ダッシュボードで API キーを作成します。キーの文字列は作成時に一度だけ表示されます。

  2. 02

    ヘッダーにキーを入れる

    すべてのリクエストに Authorization: Bearer <KEY> ヘッダーを付けてください。URL に ?api_key= を付ける方法はサーバーログにキーが残りやすいため、近く廃止する予定です。

  3. 03

    最初の呼び出し

    /api/v1/places で検索してみてください。呼び出すたびにトークンが消費され、上限を超えると 429 が返ります。

example

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://api.heyyumi.ai/api/v1/places?keyword=burger&min_confidence=0.7"

1 回の呼び出しでトークンはいくつ消費されますか?

選んだフィールドで決まります。基本の core は 1 トークンです。連絡先、営業時間、詳細情報も受け取ると、そのぶん多く消費されます。フィールドを見れば、消費量は事前にわかります。すべてのアカウントで毎月 50,000 トークンまで無料で、超えた分だけお支払いいただきます。大量利用や年間契約はお問い合わせください。

大量利用のお問い合わせ →