Quiren n8n-yhteisösolmu tarjoaa REST API:n toimintasolmuna ja käynnistinsolmun, joka aloittaa työnkulun Quiren tapahtumasta. Solmulla ei ole ajoaikaisia riippuvuuksia, joten se ei tuo n8n-asennukseesi mitään muuta kuin itsensä.
Asentaminen
Avaa n8n:ssä Settings, sitten Community nodes, valitse Install ja syötä @quire/n8n-node. Itse ylläpidetyssä n8n-asennuksessa voit vaihtoehtoisesti suorittaa npm install @quire/n8n-node n8n-käyttäjän kansiossa ja käynnistää palvelun uudelleen.
Yhdistäminen
Luo tunnistetieto. Tarjolla on kaksi tyyppiä:
- Quire API Key: Base URL on organisaatiosi osoite ilman lopun kauttaviivaa, esimerkiksi
https://acme.quirelms.com. API Key on ylläpitäjän osoitteessa/admin/integrations/api-keysluoma avain, jonka alku onqk_live_. Anna sille vain työnkulun tarvitsemat oikeudet. - Quire OAuth2: työnkuluille, joiden tulee toimia tietyn henkilön nimissä. Rekisteröi OAuth-asiakas osoitteessa
/admin/integrations/oauth-clientsja aseta sen uudelleenohjausosoitteeksi n8n:n osoite (n8n näyttää sen tunnistetiedossa). Syötä sitten asiakastunnus, salaisuus ja käyttöoikeudet.
Toiminnot
Quire-solmu kattaa käyttäjät, kurssit, ilmoittautumiset, ryhmät, suorittamiset, arvosanat, todistukset, palautukset, tietovisojen suoritukset, ohjelmat, tilaukset, sähköpostit ja organisaatiot. API:n tukemille kohteille se tarjoaa listauksen, haun, luonnin, päivityksen ja poiston sekä ulkoisen tunnisteen perusteella tehtävän upsert-toiminnon, joka sopii synkronointiin: saman työnkulun voi ajaa uudelleen ilman kaksoiskappaleita.
Toiminnot luodaan Quiren OpenAPI-dokumentista, joten ne vastaavat kenttä kentältä API-viitettä. Jokaista toimintoa voi käyttää myös n8n-tekoälyagentin työkaluna; kuvaus tulee API-viitteestä.
Listat palauttavat oletuksena kaikki sivut. Poista suurissa organisaatioissa Return All käytöstä ja määritä raja.
Käynnistin
Lisää Quire Trigger -solmu, valitse tunnistetieto ja määritä Events: tapahtuma nimen perusteella, kuten enrolment.created, kokonainen aihealue, kuten course.*, tai kaikki tapahtumat. Kun aktivoit työnkulun, solmu luo Quireen webhook-tilauksen n8n:n osoitteeseen. Kun poistat sen käytöstä, tilaus poistetaan.
Jokaisen toimituksen allekirjoitus tarkistetaan ennen työnkulun käynnistymistä. Tarkistusta läpäisemätön toimitus hylätään solmuvirheenä, joten väärennetty pyyntö ei voi käynnistää työnkulkua. Tapahtuman data sisältää tunnisteet; lisää käynnistimen jälkeen Quire-solmu, jolla haet koko tietueen.
Esimerkki: tervetuloviesti ilmoittautumisen jälkeen
- Quire Trigger, tapahtumana
enrolment.created. - Quire-solmu: resurssi Users, toiminto Get, käyttäjän tunnisteella
{{$json.data.user_id}}. - Quire-solmu: resurssi Courses, toiminto Get, kurssin tunnisteella
{{$json.data.course_id}}. - Sähköposti- tai chat-solmu, jossa käytetään henkilön nimeä ja kurssin otsikkoa.
Vianmääritys
- 401 kaikissa kutsuissa: perusosoite ja avain kuuluvat eri organisaatioille tai avain on peruttu.
- 403 yhdessä toiminnossa: avaimella ei ole kyseistä oikeutta. Lisää se osoitteessa
/admin/integrations/api-keys. - Käynnistin ei koskaan laukea: n8n:n webhook-osoitteen on oltava Quiren saavutettavissa HTTPS-yhteydellä. Tarkista tilauksen toimitusloki osoitteessa
/admin/webhooks.