n8n | Quire

Quire’i kogukonna-sõlm n8n-i jaoks pakub REST API-le toimingusõlme ja käivitussõlme, mis alustab töövoogu, kui Quire’is midagi juhtub. Sellel pole käitusaegseid sõltuvusi, seega ei lisa see sinu n8n-i paigaldusele midagi peale iseenda.

Paigaldamine

Ava n8n-is Settings, seejärel Community nodes, vali Install ja sisesta @quire/n8n-node. Ise majutatud n8n-is võid selle asemel käivitada n8n-i kasutaja kaustas käsu npm install @quire/n8n-node ja seejärel n8n-i taaskäivitada.

Ühendamine

Loo mandaat. Saadaval on kaks liiki:

Quire API Key: Base URL on sinu organisatsiooni aadress ilma lõpus oleva kaldkriipsuta, näiteks https://acme.quirelms.com. API Key on võti, mille haldur lõi aadressil /admin/integrations/api-keys ja mis algab qk_live_. Anna sellele ainult töövoo jaoks vajalikud ulatused.
Quire OAuth2: töövoogude jaoks, mis peavad tegutsema konkreetse inimese nimel. Registreeri OAuthi klient aadressil /admin/integrations/oauth-clients, kasutades n8n-i ümbersuunamisaadressi (n8n kuvab selle mandaadi juures), ning sisesta kliendi ID, saladus ja ulatused.

Toimingud

Quire-sõlm katab kasutajad, kursused, registreerimised, rühmad, lõpetamised, hinded, tunnistused, esildised, viktoriinikatsed, programmid, tellimused, e-posti ja organisatsioonid. Iga ressursi jaoks on saadaval loetlemine, hankimine, loomine, uuendamine ja kustutamine, kui API neid toetab, ning välise ID põhjal lisamine või uuendamine. Sünkroonimiseks sobib viimane: sama töövoo korduv käivitamine ei loo duplikaate.

Toimingud luuakse Quire’i OpenAPI dokumendi põhjal, seega vastavad need API viitedokumentatsioonile välja välja haaval. Iga toimingut saab kasutada ka n8n-i tehisintellekti agendi tööriistana; selle kirjeldus pärineb API viitedokumentatsioonist.

Vaikimisi tagastavad loendid kõik lehed. Suurte organisatsioonide puhul lülita Return All välja ja määra limiit.

Käivitaja

Lisa Quire Trigger-sõlm, vali mandaat ja määra Events: sündmus nime järgi, näiteks enrolment.created, terve valdkond, näiteks course.*, või kõik sündmused. Töövoo aktiveerimisel loob sõlm Quire’is n8n-i aadressile veebikonksu tellimuse; desaktiveerimisel eemaldatakse tellimus.

Enne töövoo käivitamist kontrollitakse iga edastuse allkirja. Kontrollimata edastus jäetakse kõrvale koos sõlme veaga, seega ei saa võltsitud päring sinu töövoogu käivitada. Sündmuse data sisaldab tunnuseid; lisa käivitaja järele Quire’i sõlm, et hankida täielik kirje.

Näide: tervituskiri registreerimisel

Quire Trigger sündmusel enrolment.created.
Quire-sõlm, ressurss Users, toiming Get, kasutaja ID-ga {{$json.data.user_id}}.
Quire-sõlm, ressurss Courses, toiming Get, kursuse ID-ga {{$json.data.course_id}}.
E-posti või vestlusrakenduse sõlm, mis kasutab inimese nime ja kursuse pealkirja.

Tõrkeotsing

Iga päring annab 401: baasaadress ja võti kuuluvad eri organisatsioonidele või võti on tühistatud.
Üks toiming annab 403: võtmel puudub vastav ulatus. Lisa see aadressil /admin/integrations/api-keys.
Käivitaja ei käivitu: Quire peab pääsema n8n-i veebikonksu aadressile HTTPS-i kaudu. Kontrolli edastuste logi aadressil /admin/webhooks.