Lingara 入門
このページは英語から翻訳されています。内容に相違がある場合は、英語のページが正しい内容です。 英語のページを読む
連携コードをゼロから書かなくても、ご自身のサーバーやアプリを Lingara アカウントに接続できます。レシピを選び、いくつかの項目を入力し、Lingara の実際のルールに照らして結果を確認してから、適用します。スクリプトは任意です。
作れるもの
連携は 4 つの構成要素からできています。ここではそれぞれをアプリでの呼び名で示し、その横に Lingara での用語を添えています。
- サーバーのサインイン情報(OAuth クライアント)。サーバーはこれを使って、あなたのアカウントで操作します。
- そのサインイン情報のパスワード(クライアントシークレット)。適用した直後に一度だけ表示されます。
- サーバーへのメッセージ(Webhook エンドポイント)。レッスンプランの準備ができたときなど、何かが起きると Lingara がサーバーにメッセージを送ります。
- Lingara 内のカード(アプリマニフェスト)。アプリがホームまたはレッスンプランのページにカードを表示します。
これらを手作業で組み合わせる必要はありません。レシピが構成要素とその順序を選び、「確認する」を押せば、何かが作成される前に何が作られるかがわかります。
レッスンプランの準備ができたらサーバーに知らせる
このレシピでは、サインイン情報、そのパスワード、メッセージを作成します。Web アプリから始め、ウィザードの表示に従ってください。
- 「アプリと連携」の「連携を作成」で「作成を始める」を押し、「レッスンプランの準備ができたらサーバーに知らせる」を選びます。
- 「名前と権限」で、サインイン情報に名前を付けます。
- 「送信先」で、サーバーの
https://アドレスを入力します。「スクリプトを使う」を開き、下のスクリプトを貼り付けて「試す」を押すこともできます。 - 「確認」で「確認する」を押し、「作成される内容」を読みます。
- 「適用」を押し、パスワードが表示されるたびにコピーします。どれも一度だけ表示されます。
- レッスンプランを生成し、サーバーが
lesson_plan.readyを受け取るのを確認します。
スクリプトは任意です。このスクリプトは入力項目と同じことを行い、さらにレッスンプランを作成できなかったときに Lingara が送るメッセージを追加します。
return lingara.webhook({ client: input.client, url: input.url, events: ['lesson_plan.ready', 'lesson_plan.failed'] })
次のステップ
- レシピでは、3 つのレシピすべてと、それぞれが作るものの使い方を説明しています。
- テスト、ドライラン、適用では、「確認する」が何を確認し、「適用」が何をするかを説明しています。
- Lingara 開発者ドキュメントには、スクリプトから呼び出せるすべてのものが載っています。
- 連携が作成するものはすべて、Web アプリの「開発者ツール」で手作業で作成することもできます。
関連項目
連携を作成する
- レシピ
3 つのレシピ、それぞれが作るもの、手順の順序、そして結果の使い方。
- テスト、ドライラン、適用
「確認する」を 1 回押すと何が確認されるか、「試す」が 1 つのスクリプトに対して何をするか、そして「適用」で何が作られるか。
リファレンス
- Lingara 開発者ドキュメント
手順のスクリプトが呼び出す lingara.v1 API、スクリプトに許されること、そして v1 は拡張されるだけという約束。