How to Import Data via REST API into Magento 2

Today, we’d like to draw your attention to the Magento 2 REST API Import. Depending on the edition of your Magento 2 installation, your built-in import and export tools may vary a little. However, the difference is not vast: you can create update schedules in Commerce while the Open Source edition doesn’t let you do that. The common thing is that neither of them lets you leverage the REST API import in Magento 2. Luckily, the missing functionality can be enabled with minimum effort. You only need to install the Improved Import & Export Magento 2 module. The extension offers all the features necessary to leverage the Magento 2 REST API import and export. 

The following article sheds light on how to import data into Magento 2 via REST API. We discuss how to enable the Magento 2 REST API import and what extra benefits you can get. If you are not familiar with what the Magento 2 REST API is, we’ve also prepared a chapter that describes this standard. Besides, there is an FAQ section that provides answers to frequently asked questions about Magento 2 REST API import/export processes.

Please Note: Connection to complex 3rd-party API may require custom development on top of our Improved Import & Export. Our solution is 100% open source, so we would be happy to advise how to add the necessary functionality. We can also provide you with a quote for any integration – contact us.

Magento 2 REST API Import

As you might have already guessed, it is possible to import data into Magento 2 via REST API with the help of a third-party extension. With the desired functionality enabled, you can connect your Magento 2 store to any external system transferring all the necessary information to your store in the most natural way. The only tool that completely revamps the default Magento 2 import adding the extended REST API support is the Improved Import & Export Magento 2 module.

Install the extension, and you will be able to import data via REST API to Magento 2 in the most seamless manner. Our module not only adds support for the standard but also enables multiple additional features that make your import routine much more efficient.

Most external systems that store products, customers, or other data usually work with REST API. Consequently, you can refer to the system’s REST API using your login and password and get any information you need. This nature of REST API connections opens endless opportunities regarding the Magento 2 synchronization with third-party systems. Freely import any kind of data (products, customers, categories, orders, cms pages, discounts, etc.) to Magento 2 from any REST API source.

As for the Improved Import Export extension, it also enables fully automated updates and mapping. With the REST API functionality, you can get data in XML or JSON formats and import it to Magento 2 as fast as possible implementing all modifications right in the extension’s backend.

How to Enable REST APIs in Magento 2 Import

When the Improved Import & Export extension is installed, add the following packages in app/code/Firebear to use REST API with the Firebear Import and Export extension:

• For parsing JSON: 

• For REST: 

Note! If the extension is installed via composer the libraries will be installed automatically.

Next, you can enable REST and SOAP APIs in the Import Settings section.

1. Specify the import source as one of the formats — XML/JSON. As for the Import source type, the extension supports REST and SOAP. Choose REST.
2. In the API call URL, set the endpoint of the site where the file that you want to import is situated or the content should be fetched from.
3. Next, define API request methods. Depending on the request type it should be used via GET/POST.
4. For JSON files, you need to specify the necessary parameters in the valid file body (usually it’s in the POST section).
   E.g., use this example for basic authentication:
   

If no authentication is required then you can leave it blank.

More options related to the configurations can be found at GitHub.

See the sample files for the supported file formats: XML & JSON.

For custom XML files, you can configure a relevant XSLT. See more at XSLT Documentation, XSLT sample.

If you are not sure how to use the APIs to integrate something, FireBear Studio offers its services. Contact our support team.

We will help you with Rest and Soap APIs! Drop us a line.

Additional Features for REST API Import in Magento 2

The Improved Import & Export Magento 2 module provides the ability to create any custom schedule to run the REST API import. Use the standard cron syntax to enable any custom update interval. Alternatively, you can select a predefined schedule and customize it according to your needs if necessary.

Besides, the Improved Import & Export Magento 2 extension provides the ability to create import profiles aimed at manual runs only. It is a very convenient feature for such processes as the Magento 2 migration. For instance, you need to transfer data from another store to your new e-commerce website, and the REST API data import is the easiest way to achieve this goal. Create the corresponding import profile and switch it to manual mode. Launch the profile, and it will seamlessly transfer data to your Magento 2 store via REST API.

Also, note that you can launch any automated Magento 2 REST API import manually if required. For instance, the next update is planned for the end of the week, but it is Tuesday, and you need to import the new information right now. The Improved Import & Export extension allows you to launch the Magento 2 REST API import whenever you want. The following gif image displays how to create various update schedules and choose a manual mode.

Another essential feature that makes the Magento 2 REST API import not only possible but also as easy as it could be is mapping. Every import profile includes a mapping interface where you can match the external attributes to their Magento 2 compatibles.

Since every system has its rules and requirements related to data standards, it is impossible to import information from a third-party platform to Magento 2 without applying a mapping. Since we are talking about the REST API import, you eliminate the use of data files in their standard form. Consequently, it is impossible to edit them before import so the mapping interface is the only available option. However, it is a significant advantage since mapping requires much less time and effort than manual data file editing. Furthermore, you apply it only once while manual modifications are needed before every import process. Below, you can see how a new mapping scheme is created:

There is even a more user-friendly way to eliminate issues caused by the use of different data standards. The Improved Import & Export Magento 2 extension offers mapping presets – mapping schemes already configured by our specialists. Thus, matching external attributes to Magento 2 standards is reduced to a few clicks:

To discover all the features of the Magento 2 Import & Export Magento 2 extension, watch the following video:

For further information about the Improved Import & Export Magento 2 module, follow this link:

Get Improved Import & Export Magento 2 Extension

Please Note: Connection to complex 3rd-party API may require custom development on top of our Improved Import & Export. Our solution is 100% open source, so we would be happy to advise how to add the necessary functionality. We can also provide you with a quote for any integration – contact us.

Magento 2 REST API Briefly Explained

If you are not familiar with REST, here is a brief description from StackOverflow.

Being the underlying architectural principle of the web, Representational State Transfer (REST) defines a set of constraints and properties based on HTTP. Since clients (browsers) and servers can interact without the client knowing anything beforehand about the server and its resources, the constraint occurs: both server and client must agree on the media (HTML) used.

Let’s take a look at API that adheres to the principles of REST. Its nature eliminates the necessity to know anything about the structure of the API from the perspective of the client. Indeed, the server provides all the information required by the client for interacting with the service.

An excellent example of the core REST principle is an HTML form. From the perspective of the server,  the resource location and the required fields are specified. From the perspective of the browser, it is not clear in advance what information to submit and where. The server provides the answers to both questions.

Since HTTP is oriented around verbs and resources, we should draw your attention to verbs. GET and POST are widely used and recognized by all developers. At the same, there are two fewer mainstream verbs – PUT and DELETE. All four verbs are applied to resources following the server instructions.

A user database managed by a web service will help us illustrate the situation behind REST API  in more detail. The service utilizes a custom JSON-based hypermedia. You can assign the application/json+userdb mimetype to it. Alternatively, it can be application/whatever+userdb, for instance, XML. The same fact about the client and the server is that both have been programmed to understand the specified format. But there is one problem: they don’t know anything about each other.

That’s where the REST API standard becomes helpful. It spends almost all its descriptive effort to define the media types used for representing resources and driving the app state. Alternatively, REST API can define extended relation names and hypertext-enabled markup used by the existing standard media types.

Below, you can find several examples of requests and responses. The request for the base resource “/” and the corresponding response looks as follows:

Request

Response

Now, let’s try to request information about related resources from the “Links” sections called “links”. Below, you can see a request for “/user” with the corresponding response:

Request

Response

Now, you can even create a new user by POSTing to /user:

Request

Response

Thus, the Improved Import & Export Magento 2 extension uses the aforementioned principle to refer to the system’s REST API using your login and password. As a result, it can import any information you need: products, customers, categories, orders, cms pages, discounts, etc.

For further information about REST API, follow this link: Learn REST: A RESTful Tutorial.

It describes how to build RESTful web services most professionally. The Internet industry grows daily providing developers with new and new challenges. Thus, creating a REST API requires best practices to ease development and increase client adoption. You can find all of them at RestApiTutorial.com.

Magento 2 REST API Import & Export FAQ

Final Words

Although the Magento 2 REST API import is not a feature available in the platform’s default importer, you can easily get it as a part of the Improved Import & Export functionality. Install the extension and enjoy seamless imports and exports over the API between Magento 2 and external systems. Contact us regarding your specific Magento 2 REST API import inquiries. Follow this link to learn more about our import & export extension:

Get Improved Import & Export Magento 2 Extension