7.5. REST API Logger User Guide

Owned by Piotr Matras
Last updated: Nov 21, 2022 by Krzysztof Kurzydło
2 min read

MageSuite offers a solution to monitor calls to rest API. This allows verifying the request JSON payload and response from Magento. This feature facilitates debugging integrations with external services done through the REST API, such as:

  • ERP systems (e.g. orders fetching, sending shipment data, sending invoice data)

  • warehouse management (e.g. pushing stock updates)

  • PIM (e.g. product data updates)

  • CRM (e.g. pushing/pulling customer data)

In order to enable the logger, go to STORES > CONFIGURATION > ADVANCED > SYSTEM.

Rest API Logger configuration page

Set Rest API logging enabled to YES.
Also, pick appropriate HTTP requests method to log. Most of the time it will be GET, POST, PUT.

If you want to exclude some endpoints from logs, you can specify them in the Rest endpoint to skip field (wildcard * is available).

Use the following fields for hiding sensitive data (like user passwords). Keep in mind, that placeholder needs to be specified per line.
- Payload placeholders
- Response placeholders

After logging is enabled, navigate to SYSTEM > REST API LOGGER to check the gathered logs.

Rest API logger grid