Lingara Lingara مستندات راهنماها API کتابخانه‌ها برنامه‌ها ساخت نسخهٔ وب
زبان: فارسی

دستورالعمل‌ها

این صفحه از انگلیسی ترجمه شده است. اگر این دو با هم تفاوت داشته باشند، صفحهٔ انگلیسی درست است. خواندن صفحهٔ انگلیسی

دستورالعمل اتصالی است که به نام کاری که می‌خواهید انجام دهید نام‌گذاری شده است. یکی را در برنامه‌ها و اتصال‌ها، زیر «ساخت یک اتصال»، پس از زدن «شروع ساخت» انتخاب می‌کنید. سپس راهنما مراحل آن را یکی‌یکی نشان می‌دهد و هر مرحله هنگام جابه‌جا شدن شما ذخیره می‌شود، پس می‌توانید بروید و برگردید. دستورالعملی که برنامه به شما نشان نمی‌دهد هنوز در حساب شما در دسترس نیست.

هر دستورالعمل با همان دو مرحله، «بررسی» و «اعمال»، تمام می‌شود. آزمون، اجرای آزمایشی و اعمال آن‌ها را شرح می‌دهد.

اجازه دهید سرورم Lingara را فراخوانی کند

سرور شما اطلاعات ورود و گذرواژهٔ مخصوص خودش را می‌گیرد تا بتواند از طرف شما از Lingara استفاده کند.

  • می‌سازد: اطلاعات ورود برای سرور شما (کلاینت OAuth)، و گذرواژه‌ای برای آن اطلاعات ورود (رمز کلاینت).
  • مراحل: «نام و توانایی‌ها»، «بررسی»، «اعمال».
  • پس از آن: سرور شما با آن اطلاعات ورود و گذرواژه‌اش وارد می‌شود و سپس Lingara را با توانایی‌هایی که در «چه کارهایی می‌تواند انجام دهد» به آن داده‌اید فراخوانی می‌کند.

یک اسکریپت اختیاری برای مرحلهٔ اطلاعات ورود، که نامی را که تایپ کرده‌اید نگه می‌دارد و آن را به‌عنوان مال سرور شما علامت می‌زند:

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

وقتی برنامهٔ درسی آماده شد به سرورم خبر بده

هر بار که یکی از برنامه‌های درسی شما آماده شود، Lingara پیامی به سرور شما می‌فرستد.

  • می‌سازد: اطلاعات ورود برای سرور شما، گذرواژه‌ای برای آن اطلاعات ورود، و پیام به سرور شما (نقطهٔ پایانی webhook).
  • مراحل: «نام و توانایی‌ها»، «مقصد ارسال»، «بررسی»، «اعمال».
  • پس از آن: سرور شما lesson_plan.ready را در نشانی https:// که داده‌اید دریافت می‌کند. هر پیام امضا شده است: یکی از گذرواژه‌هایی که پس از اعمال نشان داده می‌شود همان است که سرور شما برای بررسی اینکه پیام واقعاً از Lingara آمده به کار می‌برد.

یک اسکریپت اختیاری برای مرحلهٔ «مقصد ارسال»، که پیامی را هم که وقتی برنامهٔ درسی ساخته نشود فرستاده می‌شود درخواست می‌کند:

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

نمایش یک کارت درون Lingara

برنامهٔ شما یک کارت در صفحهٔ خانه یا برنامه‌های درسی شما نمایش می‌دهد.

  • می‌سازد: اطلاعات ورود برای سرور شما، و کارتی درون Lingara (مانیفست برنامه).
  • مراحل: «نام و توانایی‌ها»، «کارت شما»، «بررسی»، «اعمال».
  • پس از آن: Lingara کارت را از نشانی‌ای که در «جایی که برنامهٔ شما کارت را نمایش می‌دهد» داده‌اید درخواست می‌کند و برنامهٔ شما با آن پاسخ می‌دهد. یکی از گذرواژه‌هایی که پس از اعمال نشان داده می‌شود همان است که برنامهٔ شما برای بررسی اینکه درخواست واقعاً از Lingara آمده به کار می‌برد.

یک اسکریپت اختیاری برای مرحلهٔ «کارت شما»، که کارت را فقط در ستون کناری صفحهٔ خانه نشان می‌دهد:

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

همچنین ببینید