How to Create new API information for Integration in Magento 2


Today, my topic will point out the steps you need to follow to create API Intergration that means integrating your Magento store with a third-party API. The workflow of the API Integration is setting up the location of OAuth credentials from the Magento Admin, redirecting URL for third-party integrations, and identifying the available API resources that are needed for the integration.

Let follow the instructions below to understand specifically what you should do to create the great API integration for your own store.

Add a new integration:

  • On the Admin panel, click System. In the Extensions section, select Integrations.
  • In the upper-right corner, click the Add New Integration button and complete all information

  • In the ` Integration Info` section, do the following

How to Create new API Integration Magento 2

  • In the Name field, enter the name of the integration
  • In the Email field, enter the contact email address
  • In the Callback URL field, enter the Callback URL where OAuth credentials can be sent when using OAuth for token exchange. We strongly recommend using https://.
  • In the Identity Link URL field, enter the Identity Link URL to redirect the users to a third-party account with these Magento integration credentials.

  • In the panel on the left, choose API, do the following:

How to Create new API Integration Magento 2

  • In the Resource Access field, choose one of the following

    • All
    • Custom
  • If you choose Custom, let mark the checkbox of each resource that is needed

  • When complete, click Save button.

To change the API guest access security setting:

  • On the Admin panel, click Stores. In the Settings section, select Configuration.
  • Select Magento Web API under Services in the panel on the left
  • Open the Web API Security Setting section, and continue with following:

How to Change the API guest access security setting

  • In the Allow Anonymous Guest Access field, select Yes

  • When complete, click Save Config.

Ref: Magento 2 User Guide

Please leave comments if you have any questions, feedbacks.

Comments for How to Create new API information for Integration in Magento 2

You also may like these Magento 2 Extensions

One Step Checkout

11 reviews

Layered Navigation

5 reviews


5 reviews


7 reviews


10 reviews

Store Locator

no review

Shop By Brand

no review

Better Blog

7 reviews