Vårt abonnemangs-API används för att skapa e-postabonnemang på pressmeddelanden från Via TT. API:et kan användas för att skapa en abonnemangsfunktionalitet på användarens webbsidor.
(Dokumentation på engelska längst ned.)
Terminologi
Avsändare: ett företag eller en organisation som använder Via TT för att publicera pressmeddelanden
Abonnent: en person som abonnerar på pressmeddelanden via e-post
Autentisering
Du behöver en API-nyckel för att få tillgång till API:et. Denna API-nyckel måste inkluderas i varje request till API:et. Nyckeln placeras i reguest header "x-api-key" och API:et verifierar sedan vid varje request att nyckeln matchar avsändarens nyckel i systemet.
API-nyckeln är en universally unique identifier (UUID) som genereras av systemet. Nyckeln måste hållas hemlig och får inte delas med externa aktörer. Nyckeln är avsändarspecifik och kan alltså bara användas till en specifik avsändare, inte flera.
Här hittar du API-nyckeln
En avsändare kan hämta en API-nyckel på Via TT-sajten under Inställningar -> API-nyckel. Kontakta Via TT:s kundsupport om API-nyckelgeneratorn inte är aktiverad för avsändaren i fråga.
Tillgänglighet
API:et kan ligga nere vid systemuppdateringar. Dessa varar oftast två minuter eller kortare.
E-postverifiering och aktivering av abonnemanget
Alla nya abonnemang e-postverifieras. Ett verifikationsmejl skickas till alla nya e-postadresser i systemet.
Mejlet innehåller en aktiveringslänk. Genom att klicka på länken verifierar abonnenten sin e-postadress och aktiverar därmed abonnemanget och börjar få pressmeddelanden från avsändaren.
Så här använder du API:et
API:et måste anropas via en server. Servern måste inkludera API-nyckeln och alla nödvändiga parametrar för anropen.
Använd inte API:et från en webbklient.
Här finner du alla parametrar och specifikationer du behöver för att använda API:et: