コンテンツへスキップ

開発者

Route Royalで開発する

SDK、API、Webhook、OAuthアプリ、MCPサーバー。自社のサイトやアプリ、エージェントの開発に。開発者ツールは、開発者アクセスを付与した組織向けのポータルにあります。

  1. アクセスのある開発者

  2. サインイン済みRoute Royalアカウント
  3. お客様の組織アクセスは組織に付与
  4. お客様のロール開発者設定の管理を許可
  5. 開発者アクセス組織に付与済み
  6. 開発者ポータル認可

すべてのチェックを通過:キー、アプリ、Webhookを管理できます。

開発の手段

5つの入口

いずれも、組織のデータと付与した権限の範囲内で動作します。

  • Next.js SDK

    ブラウザ向けの型付きフックとサーバー向けクライアントで、認証、物件掲載、予約、問い合わせ、投稿、コマース、分析をヘッドレスサイトに。このサイトもSDKで動いています。

  • REST API

    api.routeroyal.comで組織のデータを読み書きできます。キーは各連携に必要な範囲に絞れます。

  • Webhook

    連絡先、商談、物件、商品、注文、支払いなどのイベントを通知。HMAC-SHA256で署名されるため、当社からの送信であることを確認できます。

  • OAuthアプリ

    Route Royalでサインインしてもらい、OAuth 2.0で本人に代わって操作できます。認可コード、トークン、失効に対応。

  • MCPサーバー

    独自のエージェントに、Route RoyalのツールをModel Context Protocol経由で提供。付与した権限の範囲内で動きます。

アクセスの取得

申請から本番キーまで

  1. 1

    アクセスを申請

    何を開発するか、どの組織向けかをお知らせください。

  2. 2

    当社が有効化

    組織の開発者アクセスを、ご相談のうえ決めた条件で有効にします。

  3. 3

    キーを作成

    サインインし、ドメインを登録してDNSで検証し、公開キーとシークレットキーを作成します。

  4. 4

    本番公開

    テストキーで開発し、公開時に本番キーへ切り替えます。

キー

2種類のキーを分けて管理

SDKキーはすべて、検証済みのドメインに紐づきます。キー全体が表示されるのは一度だけで、当社が保管するのはそのハッシュのみです。

  • 公開キー(pk_)は読み取り専用なので、ブラウザでも安全です。
  • シークレットキー(sk_)は書き込みができるため、サーバー内に置きます。
  • キーは検証済みドメインに紐づき、有効期限とIP許可リストを設定できます。
  • リクエストにはレート制限があり、ひとつの連携が他を圧迫することはありません。
.env.local
NEXT_PUBLIC_ROUTEROYAL_DOMAIN=www.example.com
NEXT_PUBLIC_ROUTEROYAL_PUBLIC_KEY=pk_test_…

# サーバー専用:ブラウザのコードには置かない
ROUTEROYAL_SECRET_KEY=sk_test_…

よくある質問

開発者からの質問

開発者アクセスは誰が取得できますか?

Route Royalをご利用の組織です。付与は組織単位で、組織内ではロールにより開発者設定を管理できる方が利用できます。

開発者アクセスは別料金ですか?

アクセスの付与時に、組織ごとに条件をご相談します。開発内容に応じた条件をお伝えしますので、お問い合わせください。

ドキュメントはどこにありますか?

アクセスに付属します。SDKはプライベートパッケージで、ガイドが同梱されています。新しい連携は、開発チームと一緒に当社が案内します。

ClaudeやChatGPTをRoute Royalで使うのに開発者アクセスは必要ですか?

いいえ。ClaudeやChatGPTを組織に接続する機能は「AIとQ」に含まれます。開発者アクセスは、独自のサイト、アプリ、エージェントを作る方向けです。

レート制限はありますか?

はい。すべてのキーとトークンにレート制限があり、AIエージェントには分単位とセッション単位の独自の制限があります。該当する制限は、アクセス付与時にお伝えします。

すでにこれで作られているものはありますか?

このウェブサイトです。ニュースはSDK経由で読み込むRoute Royalの投稿で、お客様のサイトが物件や予約、投稿を読み込むのと同じ仕組みです。

開発者アクセス

Route Royalへの最初の呼び出し

開発者アクセスは組織ごとに付与します。何を、どの組織のために作るのか教えてください。有効になったら、ポータルでキーを作成し、ご自身のキーでこの呼び出しを実行できます。

申請は support@routeroyal.com までメールでお送りください。

lib/news.ts
出力

公開キーでサーバーから投稿を2件取得しました。このサイトのニュースも同じ方法で読み込んでいます。

キーとデータはサンプルです