Magento 2 API for Mobile App

5.00 out of 5 based on 5 customer ratings

$0.00

Magento 2 API for Mobile App was built to decrease burden of the developers when developing a new mobile app, regardless of native apps or hybrid apps. Besides the main purpose of connecting Magento 2 websites to the apps, we can use this API to govern how Magento can interact with other third-party software.

  • Free download
  • Included core Magento functions
  • Applied GraphQL, REST & SOAP
  • Compability: Magento 2.3.x
Category: .

Product Description

Why Magento 2 API For Mobile App?

Unquestionably, the number of mobile users today is rising dramatically, which is even greater than the number of desktop users in some countries. Most of the Magento store owners have realized this trend and developed mobile apps to attract their customers. In general, it will take months for the app development, regardless of native apps or hybrid apps, in which developing API might consume the most of time. By using our ready-to-use Magento 2 API for Mobile App, the developers will not only save significant effort for the development but also be able to deliver the app to the store in the shortest turnaround time.

 

Magento 2 For Mobile App = GraphQL (Pros) + REST (Pros) + SOAP (Pros)

When it comes to Magento 2 API, most of us will think about GraphQL, REST, and SOAP. As you probably know, each of them has certain pros and cons, that’s why we combined all of three solutions to create the best Magento 2 API for Mobile App.

magento api for mobile app

Although GraphQL plays the most important role in our Magento 2 API, it would not be integral without SOAP and REST.

 

1. SOAP (Simple Object Access Protocol)

Released in 1998, SOAP is the most long-standing web service access protocol, developed by Microsoft.

magento 2 soap api

Pros:

SOAP defines a standard communication protocol specification for¬†XML-based message exchange using¬†different transport protocols such as¬†HTTP¬†and¬†SMTP. It’s¬†straightforward to tunnel across¬†firewalls¬†and¬†proxies¬†without any modifications to the SOAP protocol.

SOAP is often applied for enterprise-level web services that require high security or complex transactions. E.g.: APIs for financial services, payment gateways, CRM, identity management, telecommunication, etc.

Cons:

SOAP might be complicated for beginners, especially when debugging. Also, it requires more bandwidth and large resources which, in turn, slow down the page load speed.

 

2. REST (Representational State Transfer)

REST APIs was created with the aim of¬†overcoming SOAP’s constraints. It¬†is not a protocol but an architectural style that defines a set of recommendations for designing loosely coupled applications that use HTTP for data transmission.

magento 2 rest api

Pros:

REST has a flexible architecture, which allows different messaging formats, such as HTML, JSON, XML, and plain text, while SOAP only allows XML.

REST is lightweight, which is more valuable in the mobile era when a few seconds in page load time means a lot.

Cons:

Accessing data by using a REST APIs often requires multiple round-trips to collect all of the things we need.

Moreover, REST requests always return the full set of data, there is no way to limit the request to only retrieve a subset of data fields.

 

3. GraphQL

GraphQL¬†is the newcomer to the block, a revolutionary way to think about Magento APIs.¬†Like REST, GraphQL is an API design architecture, but with a different approach¬†that is more flexible. It’s true to say that GraphQL can solve an array of weaknesses and inefficiencies when interacting with REST.

magento 2 graphql api

Pros:

In GraphQL, everything is regarded as a graph and connected with each other. This means that you can tailor the request to your exact needs and describe what you want to get as an answer. In other words, you will be able to specify which fields are included to limit the response to the data which is needed to get exactly the data you are looking for in one request.

Since fewer bits will be transferred over the wire so your process using GraphQL will be faster than that of REST. No additional server round trips needed.

Cons:

GraphQL might not be suited for some APIs with few entities and relationships across entities such as analytics APIs. Another limitation is lacking built-in caching support.
As you can see, although GraphQL APIs is an amazing technology,¬†it still has some disadvantages and cannot totally replace either REST or SOAP. In most cases, it will make things simpler, but sometimes it can make simple things become complex. That’s the reason why we¬†combined GraphQL¬†to treat¬†performance as¬†the top priority with SOAP and REST to¬†ensure¬†services reliability.

 

Other Magento 2 API For Mobile App Applications

Obviously,¬†Tigren’s ready-made¬†Magento API was built to decrease the burden for the developers when creating mobile apps for Magento 2 stores. Regardless of the type of your mobile app (Native Apps/ React Native Apps/ Ionic Hybrid Apps), using our free Magento 2 API for Mobile App is the fastest way to reach your product.

However, that is not the only purpose and application of the Magento 2 API for Mobile App. It also can be used to:

  • Integrate with Customer Relationship Management (CRM)¬†such as Xero, SalesForces, Hubspot, SAP, Zoho…
  • Integrate with Enterprise Resource Planning (ERP)¬†such as¬†Microsoft Dynamics,¬†Oracle, SAGE, Odoo, NetSuite…
  • Integrate with a Content Management System (CMS)
  • Create JavaScript widgets in either Magento frontend or backend to make AJAX calls to access services

 

List of Functions in Magento 2 API for Mobile App

Initial connection setup

The initial connection is needed for REST API protocol, using OAuth for token exchange.

Some parameters are:

  1. Name
  2. Email
  3. Callback URL

Customer registration 

Registration is for customer only, collecting information is the same as the website’s including:

  1. First name
  2. Last name
  3. Email address
  4. Date of birth
  5. Gender
  6. Password
  7. Confirm password
  8. Default_billing
  9. Default_shipping

Customer authentication 

Authentication provides the customer with a valid login to access the system.

Parameters to access the system are:

  1. Email address
  2. Password

Customer details update 

Customer with valid access can update their information:

  1. Change password
  2. Edit billing address
  3. Edit shipping address
  4. Add additional billing address
  5. Add additional shipping address
  6. Edit First name and Last name
  7. Edit date of Birth
  8. Edit Gender
  9. Delete Address
  10. Toggle default billing, shipping address
  11. Add wishlist item to cart
  12.  Remove wishlist item

Customer details review 

Customer with valid access can view the following information:

  1. Account dashboard
    • Recent orders
  2. Account information
    • First name
    • Last name
    • Date of birth
    • Gender
  3. Address book suppose
    • Default billing address
    • Default shipping address
    • Additional billing address
    • Additional shipping address
  4. My orders
    • Display all orders
    • View orders, invoices
    • Re-orders
  5. My returns
    • Display return orders and status
  6. My wishlist

CMS page

Get CMS page content based on identity

  1. HTML content
  2. Page Title

Store catalog

Provide the catalog list to display in the mobile app including:

  1. Category level
    • First level
    • Second level
    • Third level
  2. Category name
  3. URL key
  4. Description
  5. Thumbnail image
  6. Image

Home page

Get data for the home page

  1. Home Banners
  2. New Products
  3. Top Sales Products
  4. Feature Products

Catalog search

Search products by name and SKU

  1. Get popular search
  2. Search by name or SKU

Product list

Provide product list to be displayed in the mobile app (derived from a category):

  1. General
    • Name
    • SKU
    • Short description
    • Description
    • URL key
  2. Configurable Attribute
    • Size
    • Color
  3. Prices
    • Price
    • Special price
    • Special price from date
    • Special price to date
  4. Images
    • Thumbnail
    • Small_image
    • Base_image
  1. Stock
  2. Quantity
  3. Stock Status

Product action

  1. Add to cart
  2. Add to wish list
  3. Add to compare

Cart

Get Cart detail for cart page

  1. Get all cart items
    • Image
    • Name
    • Options (For Configurable Product )
    • Price
    • Quantity
  2. Cart Actions
    • Update item
    • Remove item
    • Update cart
    • Clear cart

Coupon code

Provide discount based on Magento coupon code:

  1. Provide a check to see if the coupon usage is applicable
  2. Provide a check to see if the customer is able to use the coupon
  3. For active coupon code, apply the discount
  4. Apply coupon at cart page & checkout page

Checkout

Provide API for recording the checkout:

  1. Purchased on
  2. Bill to name
  3. Ship to name
  4. Base price
  5. Purchase price
  6. Status
  7. Payment information
  8. Shipping and handling
  9. Product
    • Product name
    • SKU
    • Color
    • Size
    • Original price
    • Price
    • Quantity
    • Subtotal
    • Tax
    • Discount Amount
    • Row total

Checkout Actions

Provide API for recording the checkout:

  1. Submit new address to change shipping address
  2. Save shipping address
  3. Save shipping method
  4. Save payment method
  5. Place order

 

Changelog

Version 1.0.0: Module release

Date: June 7, 2019

5 reviews for Magento 2 API for Mobile App

Paul
5 out of 5

Paul:

It’s nice to use GraphQL to develop the API for Magento 2.

Jean
5 out of 5

Jean:

Although this API only provides core features, it still cut significant time for API development. Good job!

Caden
5 out of 5

Caden:

I guess it would be useful for Magento 2 and ERP integration…

Dan
5 out of 5

Dan:

It will help us to save a lot of time when developing new mobile apps for Magento 2.

Armand
5 out of 5

Armand:

I like the way it combines GraphQL, REST and SOAP.

Add a review