Quire-dokumentasie

Gidse vir almal wat Quire gebruik, en die verwysing vir almal wat daarop bou. Kies die gids vir die werk wat jy doen.

Begin by jou rol en volg dan die onderwerpgidse vir die taak voor jou. Ontwikkelaars kan die volledige Engelse API-verwysing saam met enige taalweergawe van hierdie gidse gebruik. Operateurs behoort met die installasieprosedure te begin en die rugsteun- en opgraderingsgidse byderhand te hou voordat hulle veranderinge aanbring.

• Administrateurs

  Die opstel van ’n organisasie: mense, rolle, aanmelding, handelsmerk, tale, e-pos en rekords

• Onderwysers

  Kursusse bou, saam bladsye skryf, werk opstel en nasien

• Leerders

  Kursusse vind, vanlyn studeer en Quire gemaklik maak om te lees

• Ontwikkelaars

  Die REST API, OAuth, webhooks en die MCP-bediener

• API-verwysing

  Elke eindpunt en webhook-gebeurtenis, gegenereer uit die OpenAPI-dokument

• Operateurs

  Quire self huisves, installeer, opgradeer, rugsteun en sleutels roteer

Administrasie- en onderrigonderwerpe

• Organisasie-instellings

  Adresse, verstektaal, skakelaars en gegradeerde rolle

• Plan en fakturering

  Wat elke plan insluit, gebruik, planveranderinge en gemete byvoegings

• Deel tussen organisasies

  Die gedeelde ruimte en hoe ’n gedeelde kursus in ’n spieëlomgewing werk

• Uitbreidings

  Wat ingebou is en hoe om dit aan of af te skakel

• Verskaffers vir regstreekse sessies en video

  Jou eie BigBlueButton-, Zoom-, Teams-, Meet-, Jitsi-, Cloudflare Stream-, Mux- of Bunny-rekening

• KI-kenmerke

  Verskaffers, kenmerke, beleid, begroting en wie tutor-gesprekke gelees het

• Beleide en aanvaarbare gebruik

  Beleide publiseer, aanvaarding en afdwinging van aanvaarbare gebruik

• Inhoudbank

  Lêers en interaktiewe inhoud oor kursusse heen hergebruik

Integrasiegidse

• n8n

  n8n-werkvloeie met die Quire-gemeenskapsnodus

• Zapier

  Zapier deur webhooks en die REST API

• Make

  Make-scenario’s deur webhooks en die REST API

• HubSpot

  HubSpot-kontakte, maatskappye, werkvloeie en die kontakrekord

• LTI 1.3

  Eksterne leernutsgoed en H5P

• Enkel aanmelding

  Jou identiteitsverskaffer via OpenID Connect of SAML, en SCIM-voorsiening

Konvensies in hierdie gidse

• ’n Pad soos /admin/users is ’n bladsy by jou organisasie se adres, byvoorbeeld https://acme.quirelms.com/admin/users.
• Wat jy kan sien, hang van jou rol af. As ’n bladsy in ’n gids vir jou ontbreek, het jou administrateur nie daardie toestemming aan jou rol gegee nie.
• Quire vee nooit iets uit sonder om eers te sê wat gaan gebeur nie. Waar ’n gids sê “verwyder”, verwag ’n bevestiging wat die gevolg benoem.