Octany. for/devs
§ 01 — Insamling · Givarportal

En portal där givare sköter sitt givande.

Givarportalen (portal-v1) låter dina givare logga in med BankID och se sina gåvor, ändra eller avsluta ett månadsgivande, byta betalsätt, ladda ner kvitton och hålla sina uppgifter uppdaterade. Den är en widget precis som insamlings-embedsen: lägg den på din egen sida, länka till den hostade sidan eller lägg den hostade sidan i en iframe.

§ 01.8.1 Vad givare kan göra #

OmrådeDet här kan en inloggad givare göra
PrenumerationerSe månadsgåvor och andra prenumerationer. Ändra belopp, avsluta, återuppta en avslutad innan den har löpt ut, och byta betalsätt eller uppdatera kortet.
OrdrarBläddra bland tidigare gåvor och köp och ladda ner kvitton som PDF.
ProfilSe och ändra sina kontaktuppgifter.
Event och formulärSe eventanmälningar och inskickade formulär.

Vad som syns beror på ditt konto och portalens inställningar. Har ni inte den fullständiga givarportalen i ert Octany-avtal kan givarna bara hantera betalsättet på sina prenumerationer. Att ändra belopp och att avsluta går att stänga av var för sig per portal. Beloppet går bara att ändra på gåvoprenumerationer.

§ 01.8.2 Bädda in på din sida #

Det här är det rekommenderade sättet, och det du ska välja om du vill behålla din egen header, meny och footer runt portalen. Kopiera embed-koden från portalen i Octany admin. Den har samma form som alla andra insamlings-embeds:

<div class="octany-portal-widget"></div>
<script
  type="module"
  src="https://give.octany.com/portal-v1/loader.js?api=https://app.octany.com/widget/1234&widget=01HXXXXXXXXXXXXXXXXXXXXXXX"
></script>
ParameterObligatoriskBeskrivning
apiJahttps://app.octany.com/widget/{account}, där {account} är ditt konto-ID.
widgetJaPortalens widget-ID, 26 tecken.
langNejSpråkkod med två bokstäver, t.ex. sv eller en. Utan den används portalens språk.

Det här är ingen iframe. Portalen renderas direkt i containern, inuti en Shadow DOM, så din CSS når inte in i portalen och portalens CSS läcker inte ut på din sida. Den fyller containerns bredd.

Kör du WordPress renderar Octanys plugin samma snutt med [octany type="portal-v1" account="1234" widget="01HXXXXXXXXXXXXXXXXXXXXXXX"] eller blocket Octany-widget.

§ 01.8.3 Hostad sida #

Varje portal har också en egen sida hos Octany. Det är förhandsvisningslänken i Octany admin:

https://app.octany.com/widget/{account}/{widget}/portal

Sidan innehåller bara portalen och fyller hela skärmen. Länka dit från menyn på din sajt om du inte vill bädda in något.

Påminnelsemejl om betalning När en betalning på en prenumeration misslyckas länkar Octanys påminnelsemejl till den hostade sidan, inte till sidan där du har bäddat in portalen. Länken öppnar portalen direkt på prenumerationens betalsätt, utan BankID. Den sessionen kan bara byta betalsätt på just den prenumerationen. Ge därför portalen din profil (logga, färger, herobild) även om du bara tänkt bädda in den: givarna kommer att se den hostade sidan också.

§ 01.8.4 iframe #

Du kan lägga den hostade sidan i en iframe. Octany blockerar inte inramning, och portalen håller inloggningen i sidan i stället för i cookies, så det fungerar även när webbläsaren blockerar tredjepartscookies.

<iframe
  src="https://app.octany.com/widget/1234/01HXXXXXXXXXXXXXXXXXXXXXXX/portal"
  title="Mitt givande"
  style="display:block; width:100%; height:85vh; border:0"
></iframe>

Bädda in hellre när du kan: du får samma resultat utan iframe och inget att ställa in höjd på.

§ 01.8.5 Behåll din header #

Både inbäddningen och iframen behåller din egen header, meny och footer runt portalen. Några saker i portalens layout är bra att planera för:

§ 01.8.6 Inloggning #

Givare loggar in med BankID: genom att skanna en QR-kod eller öppna BankID-appen på samma enhet. Portalen loggar in dem som en kontakt som redan finns i Octany. Det finns ingen registrering, så en givare som aldrig har gett eller importerats kommer inte in.

Kontakter utan personnummer i Octany kan inte matchas via BankID. Slå på Tillåt aktivering via e-post eller SMS för kontakter utan personnummer så kan de visa vilka de är med en kod till sin e-post eller telefon. Sedan bekräftar de med BankID, och personnumret läggs till på kontakten. Därefter loggar de in med BankID som alla andra.

§ 01.8.7 Sessioner #

Efter inloggning sparar portalen en sessionstoken i webbläsarens sessionStorage på din sidas domän, en per portal. Inga cookies är inblandade. I praktiken:

Eftersom inloggningen ligger i din sidas lagring följer den aldrig med till inloggningen på din egen sajt. Portalen och din sajt delar inte användare.

§ 01.8.8 Inställningar #

Ställ in de här på portalen i Octany admin:

InställningVad den gör
Ideell portalAnvänder gåvotermer i stället för köptermer. På som standard.
HerobildBild överst i portalen och på inloggningsskärmen.
FärgerBakgrund, rubriker, flikarnas bakgrund och text, aktiv fliks bakgrund och text.
Tillåt aktivering via e-post eller SMS för kontakter utan personnummerSe Inloggning.
Tillåt kontakter att ändra prenumerationsbeloppVisar ändra belopp på gåvoprenumerationer.
Tillåt kontakter att avsluta prenumerationerVisar avsluta.
Webbplats-URLVisar en "Tillbaka till {sajt}"-knapp i portalens header. Lämna tom för att dölja knappen.
Utloggnings-URLDit fönstret skickas efter utloggning. Lämna tom för att stanna på inloggningsskärmen. Använd en https://-URL.

§ 01.8.9 Krav #