GraphQL-Api
Das Modul bietet eine GraphQL-Schnittstelle, um Konfigurationsdaten für das Modul zu ermitteln und z.B. für PWA-Magento-Shops auszugeben. Des Weiteren bietet es noch einen Api-Funktion um den Subscription-Status zu prüfen.
Modulkonfiguration
Mit folgendem Request kann die Modulkonfiguration store-spezifisch abgefragt werden:
Request:
https://www.domain.tld/graphqlQuery:
query {
getCheckoutNewsletterSubcriptionConfig(
storeCode: "default"
) {
moduleEnabled
autoSubscription
subscriptionText
magentoNewsletterEnabled
magentoGuestNewsletterAllowed
checkboxDisplayArea
}
}Response:
{
"data": {
"getCheckoutNewsletterSubcriptionConfig": {
"moduleEnabled": true,
"autoSubscription": false,
"subscriptionText": "Subscribe to Newsletter",
"magentoNewsletterEnabled": true,
"magentoGuestNewsletterAllowed": true,
"checkboxDisplayArea": "shipping-email"
}
}
}Subscriptionstatus
Mit folgendem Request kann der Subscriptionstatus eines Users anhand der E-mail abgefragt werden:
Request:
https://www.domain.tld/graphqlQuery:
query {
getSubscriberStatusByEmail(
email: "user_1@example.com"
) {
isSubscribed
}
}Response:
{
"data": {
"getSubscriberStatusByEmail": {
"isSubscribed": true
}
}
}