Bij sommige interfaces moet je een API-sleutel, een lijst-ID en/of een formulier-ID invoeren. Met deze informatie kunt u uw CleverReach-account verbinden met een externe interface. Om verbinding te maken met bijvoorbeeld Magento, Veyton, Shopware en Wordpress zijn dergelijke sleutels verplicht.
Een API-sleutel maken/lokaliseren
Je kunt deze informatie direct in je account vinden. Ga gewoon naar [Mijn account] > [Extra's] > [SOAP API]. Als u nog geen API-sleutel hebt aangemaakt, moet u een sleutel toevoegen - als uw gebruiker daartoe gemachtigd is. Klik op [API-sleutel aanmaken] en voer de gegevens in.
| Doel van gebruik: | interne naam voor administratieve doeleinden |
| Toegangsrechten: | bepaalt de rechten van de sleutel ("lees- en schrijfrechten" of "alleen leesrechten") |
Je kunt nu de nieuw aangemaakte API-sleutel kopiëren en invoeren om verbinding te maken met een externe interface.
Lijst-ID's vinden
De lijst-ID is een unieke ID van de betreffende ontvangersgroep. U vindt de lijst-ID in de algemene instellingen van de ontvangersgroep onder [Instellingen] > [Algemeen].
ID's van formulieren vinden
Elk formulier heeft een unieke ID, waarmee je bijvoorbeeld de dubbele opt-in kunt activeren via een externe interface (afhankelijk van de interface). Je vindt de formulier-ID in de algemene instellingen van het formulier onder [Instellingen] > [Informatie].
Belangrijke opmerkingen:
- De aangemaakte API-sleutel is geldig voor de hele account. Als je verbinding wilt maken met meerdere externe platforms (bijv. Shopsystem en Wordpress) hoef je niet voor elk platform een nieuwe API-sleutel aan te maken. De lijst-ID bepaalt aan welke groep een registratie wordt toegewezen. Natuurlijk kun je per extern platform een andere API-sleutel gebruiken als dit vereist is voor je opstelling.
- Zorg er bij het gebruik van onze API voor dat u "Lees- en schrijfrechten" selecteert, omdat er anders geen gegevens worden overgedragen. De optie "Alleen leesrechten" is alleen bedoeld voor API-verbindingen waarmee je eenvoudig gegevens kunt lezen zonder deze over te dragen.
- Je kunt op elk moment nieuwe API-sleutels aanmaken en bestaande sleutels verwijderen of deactiveren. Houd er rekening mee dat u uw verbinding met een extern platform moet aanpassen wanneer u uw API-sleutels wijzigt.
- Om een lijst-ID te krijgen, moet je eerst een ontvangersgroep maken.
- Om een formulier-ID te krijgen, moet je een formulier maken voor de betreffende ontvangersgroep.
- Als je de API wilt gebruiken, moet je ervoor zorgen dat de SOAP-clientfunctie op je webserver is ingeschakeld.