GDPR API Guide for Extensions

GDPR API

Info
We have created a public API collection for GDPR module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post.

1. Amasty\Gdpr\Api\RequestInterface - class for managing personal data deletion requests.
  1. POST /V1/amasty_gdpr/approveDeleteRequest, method="approveDeleteRequest" - approve a request;
  2. POST /V1/amasty_gdpr/denyDeleteRequest, method="denyDeleteRequest" - deny a request;
  3. GET /V1/amasty_gdpr/getUnprocessedRequests, method="getUnprocessedRequests" - get a list of unprocessed requests.

2. Amasty\Gdpr\Api\WithConsentRepositoryInterface - class to access Consent Log data
  1. GET /V1/amasty_gdpr/getConsentLog” method="getList" -  obtain the data from the Consent Log grid, including customer ID, IP address, customer email, date, checkbox location, checkbox code, policy version, website, and action (exception - customer name).
Notes
Please note that the ability to access Consent Log data via API was introduced with the extension version 2.14.0. If you can't locate the API request described above, make sure your extension is version 2.14.0 and higher.

      • Related Articles

      • What Amasty extensions support API?

        Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...

      • Can I test how your modules work with API?

        Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be ...

      • GDPR | GraphQL methods

        Queries amGetGdprConsents (location: String) description: information about GDRP consents amGetGdprAccount description: information about GDPR account settings amGetGdprPolicyText (id: Int) description: get GDPR policy text Mutations ...

      • What is the difference between CCPA and GDPR?

        The CCPA and GDPR modules look similar, however, there are certain nuances to both of them due to them being tailored for two different laws. While both of them allow you to create multiple checkboxes, and your customers — to download their data and ...

      • RMA API

        We have created a public API collection for RMA module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public collections can ...