Deze module is niet standaard beschikbaar. Neem contact op met je accountmanager/consultant om dit te activeren.
Dit artikel is alleen relevant voor organisaties die vrijetijdsactiviteiten (cultuur, sport, jeugd, toerisme) in Vlaanderen en/of Brussel organiseren.
Verkrijgen van API credentials bij de UiTdatabank
De koppeling die beschikbaar is, is de "Entry API". Om hier gebruik van te kunnen maken, is het noodzakelijk om hiervoor credentials te verkrijgen.
Hiervoor ga je naar deze website, registreer je of meldt je aan op het Publiq platform, de organisatie achter onder meer Uit in Vlaanderen en de UiTdatabank. Vervolgens voeg je een integratie toe.
Zodra je een nieuwe integratie toe gaat voegen, kies je voor de "Entry API" en vul je de gevraagde gegevens voor je organisatie in en maak de integratie aan. Zodra dit gedaan is, zal je "Test API credentials" krijgen, deze zijn nodig bij het inrichten.
Het is mogelijk om 1 set credentials in te voeren. Wanneer er bijeenkomsten van bijvoorbeeld afdelingen naar Uit in Vlaanderen moeten, hebben deze geen eigen credentials nodig.
Om live credentials te verkrijgen, is het noodzakelijk 5 test-bijeenkomsten succesvol met de test-credentials te versturen en vervolgens contact op te nemen met Publiq. Informatie hierover is terug te vinden in de API documentatie van Publiq
Meer informatie over het versturen van (test-)bijeenkomsten naar de UiTdatabank, is op deze pagina te vinden.
Instellen in de backend
Om de benodigde instellingen te kunnen doen in de backend, ga je naar https://jouw-implementatie.procurios.cloud/uit_in_vlaanderen en vul je de vereiste velden in.
Algemene instellingen
- De naam die wordt meegestuurd als organisator van de bijeenkomst die naar de UiTdatabank
- De website die bij Uit in Vlaanderen aangegeven wordt. Stel hier een website in waarop inloggen niet verplicht is
- Het is mogelijk om elke bijeenkomst automatisch hetzelfde voorvoegsel mee te geven bij Uit in Vlaanderen
- De website die voor afbeeldingsurls gebruikt wordt. Hiervoor geldt ook dat hier een website ingesteld moet worden waarop inloggen niet verplicht is
- In de eerste fase staat deze module in testmodus, dit is nodig om de eerder genoemde 5 test-bijeenkomsten te kunnen versturen. Nadat je de live credentials hebt gekregen, kan je deze instelling op live zetten en op de juiste plaats de live credentials invoeren
Organisatoren
Dit is enkel van toepassing wanneer bijeenkomsten door een onderdeel van de organisatie, bijvoorbeeld een afdeling, naar Uit in Vlaanderen gestuurd worden en deze informatie mee gestuurd moet worden.
Om hier gebruik van te maken, is het noodzakelijk om afdelingsbijeenkomsten in te hebben gesteld.
- Wanneer een organisator niet gekozen is of de vereiste informatie beschikbaar heeft, wordt er teruggevallen op een vooraf geselecteerde relatie waarbij alle informatie in orde is. Deze selecteer je hier
- Het voorvoegsel voor de organisator. Standaard wordt de relatienaam uit het CRM gebruikt, zonder aanvullende informatie. Stel je in dit veld de organisatienaam in, zal de organisator "Organisatienaam relatienaam" zijn
- Wanneer een afdeling een bijeenkomst organiseert, willen ze vanuit de afdeling dat geïnteresseerden naar de website van hun afdeling komen, door hier het vrije veld in te stellen, zal de website in het geselecteerde vrije veld meegestuurd worden naar Uit in Vlaanderen
- Via telefoontypen is het mogelijk om een type telefoonnummer mee te sturen, wanneer dit veld bij een afdeling is ingevuld
Entry API 3 instellingen
Bij het toevoegen van een integratie bij Publiq, heb je test-credentials gekregen, in deze velden voer je de gegevens die je daar hebt gekregen in.
Nadat je dit gedaan hebt, kan je test-bijeenkomsten versturen om live credentials te kunnen krijgen.
Heb je de live credentials gekregen van Publiq, vergeet dan niet in de instellingen de credentials aan te passen en in te stellen dat gegevens voortaan naar de live omgeving verzonden moeten worden