Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

  • ERP system systems (e.g. order pullorders fetching, sending shipment pushdata, sending invoice pushdata)

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

  • PIM (e.g. product pushdata updates)

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

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

...

Set Rest API logging is enabled to YES.
Also, choose pick appropriate HTTP requests method to log. Mostly 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 enabling logslogging is enabled, navigate to SYSTEM > REST API LOGGER to check the gathered logs.

...