Lingara Lingara ドキュメント 学習ガイド API ライブラリ アプリ 作成 ウェブ版
言語: 日本語

レシピ

このページは英語から翻訳されています。内容に相違がある場合は、英語のページが正しい内容です。 英語のページを読む

レシピとは、やりたいことに合わせて名前が付けられた連携です。「アプリと連携」の「連携を作成」で「作成を始める」を押した後に選びます。その後、ウィザードは手順を 1 つずつ表示し、各手順は移動するたびに保存されるので、途中で離れて後から戻ることができます。アプリに表示されないレシピは、まだあなたのアカウントでは利用できません。

どのレシピも、最後は同じ 2 つの手順「確認」と「適用」で終わります。これらはテスト、ドライラン、適用で説明しています。

サーバーから Lingara を呼び出せるようにする

サーバーに専用のサインイン情報とパスワードが用意され、あなたの代わりに Lingara を使えるようになります。

  • 作成されるもの: サーバーのサインイン情報(OAuth クライアント)と、そのサインイン情報のパスワード(クライアントシークレット)。
  • 手順: 「名前と権限」、「確認」、「適用」。
  • その後: サーバーはそのサインイン情報とパスワードでサインインし、「できること」で与えた権限を使って Lingara を呼び出します。

サインインの手順で使える任意のスクリプトです。入力した名前をそのまま使い、サーバー用であることを示します。

return lingara.client({ name: input.name + ' (server)', scopes: input.scopes })

レッスンプランの準備ができたらサーバーに知らせる

レッスンプランの準備ができるたびに、Lingara がサーバーにメッセージを送ります。

  • 作成されるもの: サーバーのサインイン情報、そのサインイン情報のパスワード、サーバーへのメッセージ(Webhook エンドポイント)。
  • 手順: 「名前と権限」、「送信先」、「確認」、「適用」。
  • その後: サーバーは lesson_plan.ready を、入力した https:// アドレスで受け取ります。各メッセージには署名が付いています。適用後に表示されるパスワードのうちの 1 つは、メッセージが本当に Lingara から来たことをサーバーが確認するためのものです。

「送信先」の手順で使える任意のスクリプトです。レッスンプランを作成できなかったときに送られるメッセージも要求します。

return lingara.webhook({ client: input.client, url: input.url, events: [...input.events, 'lesson_plan.failed'] })

Lingara 内にカードを表示する

アプリがホームまたはレッスンプランのページにカードを表示します。

  • 作成されるもの: サーバーのサインイン情報と、Lingara 内のカード(アプリマニフェスト)。
  • 手順: 「名前と権限」、「あなたのカード」、「確認」、「適用」。
  • その後: Lingara は「アプリがカードを表示する場所」に入力したアドレスにカードを要求し、アプリはカードで応答します。適用後に表示されるパスワードのうちの 1 つは、リクエストが本当に Lingara から来たことをアプリが確認するためのものです。

「あなたのカード」の手順で使える任意のスクリプトです。カードをホームページのサイドカラムにだけ表示します。

return lingara.app({ client: input.client, manifest: lingara.manifest({ ...input.manifest, slots: ['home.side'] }) })

関連項目