API Plugin

Picture of API Plugin
This plugin provides a RESTful API for managing resources in nopCommerce.
- current rating is 4.53. Total reviews 34
API Plugin
Supported Versions: 3.70 , 3.80 , 3.90 , 4.00 , 4.10
Created: 20 October 2016
Last updated: 27 September 2018
Free
Get extension You will be re-directed to the developer's website to download this plugin
Description

This plugin provides a RESTful API for managing resources in nopCommerce. A resource is a data object that can be accessed via an HTTP request. The API allows you to “access your nopCommerce site’s data (resources) through an easy-to-use HTTP REST API”. The most recent version of the API (nopCommerce version 4.00), the resources include the following 7 nopCommerce objects:

  • Customers
  • Products
  • Products Categories
  • ProductCategoryMappings
  • Orders
  • OrderItems
  • ShoppingCartItems

With the nopCommerce API, you can perform any of the four CRUD actions against any of your nopCommerce site’s resources listed above. For example, you can use the API to create a product, retrieve a product, update a product or delete a product associated with your nopCommerce website.

The plugin also supports WebHooks.

 

For more information and source code you can visit the GitHub page: https://github.com/SevenSpikes/api-plugin-for-nopcommerce

Reviews
Version 4.1? Swagger?
pcook
11/16/2018 4:13 PM
I've downloaded this and can connect via Postman but accessing the Swagger documentation results in a not found. Can you provide instructions how to connect successfully to Swagger or identify when this will be fixed?
Was this review helpful? Yes  No (1 / 0)
3.9 support , i get exception
maxofpower
11/3/2018 5:14 AM
website goes down and i get this exception :

ValueFactory attempted to access the Value property of this instance.
Was this review helpful? Yes  No (0 / 0)
How to Get Access Token using Nopcommerce UserID and Password?
tmanoharc
11/3/2018 4:49 AM
Right now sample client retrieves AccessToken using Authorization Code flow, for my needs, please let us know How to Get Access Token using Nopcommerce UserID and Password?
Was this review helpful? Yes  No (0 / 0)
Postman Test
Paradaim
10/20/2018 5:29 AM
How get Token from postman with username and password
Was this review helpful? Yes  No (0 / 1)
A vendor responded to this review
Please read this post where it is explained - https://www.nopcommerce.com/boards/t/48824/how-to-test-nopcommerce-rest-api-provided-by-nop-template.aspx
Is there any plan for supporting 4.1?
feraree
9/25/2018 4:54 AM
Very helpful web api services.

Thanks you development team.
Was this review helpful? Yes  No (0 / 0)
Unable to install API Plugin
rahul.balodi.cipl
9/18/2018 11:47 PM
We tried installing API Plugin 4.0 with NOP Commerce 4.0, but while installing API Plugin, it crashes the visual studio. And restarting the NOP Commerce application gives us the error

"FileNotFoundException: Could not load file or assembly 'Nop.Plugin.Api' or one of its dependencies. The system cannot find the file specified.

System.Reflection.RuntimeAssembly._nLoad(AssemblyName fileName, string codeBase, Evidence assemblySecurity, RuntimeAssembly locationHint, ref StackCrawlMark stackMark, IntPtr pPrivHostBinder, bool throwOnFileNotFound, bool forIntrospection, bool suppressSecurityChecks) "

Please help us ASAP.
Thanks.
Was this review helpful? Yes  No (0 / 0)
Add support for 3.5
sanjay-btc
9/11/2018 9:13 AM
I want to customize and want to add support for nopCommerce v3.5.

Can you please tell me what needs to do for this?
Was this review helpful? Yes  No (0 / 0)
where it for the 4.10 version ?
jkevlorayna
8/20/2018 3:01 AM
not applicable in version 4.10?
Was this review helpful? Yes  No (2 / 0)
Support for 4.1?
kkbv
7/30/2018 10:02 PM
Hi,
We picked up 4.1 this weekend - do you have a roadmap to support 4.1 in the next few weeks? Or, could it be longer?

Regards,
kk
Was this review helpful? Yes  No (3 / 0)
Support for 4.1?
kkbv
7/30/2018 10:02 PM
Hi,
We picked up 4.1 this weekend - do you have a roadmap to support 4.1 in the next few weeks? Or, could it be longer?

Regards,
kk
Was this review helpful? Yes  No (3 / 0)
How can I use UserIdentity in this API
[email protected]
7/28/2018 9:23 AM
Hello,
Thanks for providing this beautiful Plugin.
I just wonder that how we can implement user identity in this project, so that we can identify user on each API method call.
There is already a folder named "IdentityServer" but I don't know it is for User Identity or anything else.

Could you please help me here how we can Implement Microsoft.AspNetCore.Identity (IdentityUser) or any other option to achieve this?

Thanks in advance
Ram
Was this review helpful? Yes  No (0 / 0)
Very Bice
kleberapsilva
5/4/2018 12:05 AM
Very Bice
Was this review helpful? Yes  No (0 / 0)
API plugin 4.0 is not working properly
ApoorvaSrivastava
4/24/2018 3:33 AM
Hi,
I am using NOPCommerce 4.0 along with API plugin 4.0 provided by the same link.
After adding the api plugin I am not able to add any controller in Nop.Web and if I add controller from another project it starts to giving a dependency injection exception.

Plugin 'Api plugin'. Could not load file or assembly 'Microsoft.EntityFrameworkCore.Relational, Version=2.0.1.0, Culture=neutral, PublicKeyToken=adb9793829ddae60' or one of its dependencies. The system cannot find the file specified.
Could not load file or assembly

I tried everything from my side but couldn't find any solution,  if I unload the api plugin project it starts working properly.
Was this review helpful? Yes  No (0 / 0)
How to use this API for windows and mobile application
[email protected]
4/18/2018 7:51 AM
Hi,
I want to know how to use these APIs for desktop and mobile application, because it uses "Callback Url" while we create client at Admin.
In case of mobile and desktop application the "Callback Url" will be changed for every time when new user will use my desktop/mobile application.

Please help me.
Thanks in advance.
Was this review helpful? Yes  No (0 / 0)
NOP API plugin conflicting with Google API
dwarapudi
3/27/2018 4:39 AM
Hi, we tried to install this plugin and it conflicts with Google API and receiving Internal Server Error.

An error occurred while starting the application.
.NET Framework 4.7.2563.0 X86 v4.0.0.0    |   Microsoft.AspNetCore.Hosting version 2.0.0-rtm-26452    |    Microsoft Windows 10.0.14393
Was this review helpful? Yes  No (0 / 1)
A vendor responded to this review
What do you mean by "Google API" and how exactly it conflicts with it?

p.s: We have already replied to your issue in GitHub
api-plugin-for-nopcommerce 3.9
jitendrapatidar07
2/17/2018 2:40 PM
i have jitendra patidar i have install api plugin but not use api api/product please help me
Was this review helpful? Yes  No (0 / 0)
is 4.0 rest api out ??
RohitasBehera
1/19/2018 5:51 AM
is 4.0 rest api out ??
Was this review helpful? Yes  No (0 / 0)
A vendor responded to this review
Version 4.00 has been released
Nopcommerce 4.0
[email protected]
1/14/2018 10:34 PM
Hi,
Waiting for version 4.0

any specific date for the release?
Was this review helpful? Yes  No (0 / 0)
A vendor responded to this review
Version 4.00 has been released
will it support multiple stores
[email protected]
12/31/2017 2:52 PM
Will this Extension support multi store?
Was this review helpful? Yes  No (1 / 0)
Installation on version 4.
sumit20
12/29/2017 1:33 AM
I am new to nopCommerce please help me how can i install this plugin on nop.
Was this review helpful? Yes  No (0 / 0)
Access API from Android app
aswaaq
12/26/2017 6:06 AM
This is an amazing Feature.
Any Documentation available to access the API from android Application.
Thank you
Was this review helpful? Yes  No (0 / 0)
API for version 4.0
AxelAndersen
12/12/2017 9:38 AM
Hi

I am running nopCommerce 4.0. Is there an API plugin for that?
Was this review helpful? Yes  No (1 / 0)
A vendor responded to this review
We are currently working on the upgrade to 4.0 but a lot of libraries that we used as not supported yet in ASP.NET Core and we are working on alternative solutions. We hope we will be able to release a compatible version before the Christmas holidays.
Customer Login
jShehab
10/29/2017 2:21 AM
Thank you very much for the great plugin..

Is there an endpoint to authenticate the customer by his login Id and password?
Was this review helpful? Yes  No (1 / 0)
Customer Login
jShehab
10/29/2017 2:21 AM
Thank you very much for the great plugin..

Is there an endpoint to authenticate the customer by his login Id and password?
Was this review helpful? Yes  No (0 / 0)
A vendor responded to this review
Currently such authentication is not supported in the API plugin.
Excellent for ERP integration
DanielaM
10/11/2017 3:57 AM
This plugin is EXCELLENT, very useful to sync nopCommerce with ERP systems. It is, however, not complete and a little outdated. Download the source code and sample application from GitHub to add missing code.

- - -

MY PERSONAL EXPERIENCE

I used it for a customer that has been running a physical store for years and has only recently asked me to create the eCommerce site.
He already has a highly customized ERP system for maintaining commerce data, with more than 300 tables, including products and customers.
So although nopCommerce has a wonderful Admin panel he considered it an overhead maintaining two systems and asked me how long it would take to build an automatic one way sync mecchanism from his ERP to NopCommerce, for now constantly updating product prices and quantities.
I said I honestly didn't know, I'd take one day to do some analysis, see what plugins were available and give him a more precise estimate by the end of the day.
Luckily I found this amazing plugin, downloaded the source code and accompanying sample. The API is easy to change as you simply mimic the database structure to provide any missing functionality. The sample is tougher as it's very basic, but it does show how to call the API functions and how the token authentication mechanism works.
This is what I personally did:
1) Copied the sample MVC web application on a server on the intranet with IIS and created a CNAME record so that it could be accessed as http://nopSync
2) Gave it the same "look and feel" as the nopCommerce Admin panel by doing "view source" and referencing most of the same css files
3) Removed the login form and session variables, hard coded credentials in web.config and automatically authenticated on load  
4) Used a SQL script to insert SKU and Manufacturer for all nopCommerce products. These two combined fields were my key to uniquely match products between the two systems
5) The api provides a "list" function to select all products but updates are performed one by one.
I could have read all the products and then with a loop accessed the ERP system each time, checking the price and quantity and updating nopCommerce if there were differences.
However, I considered it more performant to read all the nopCommerce data into a local database PRODUCTS table with a DoesItRequireUpdating flag by default equal to false.
The benefit of this was that the ERP system would only be accessed once. With a single query on the PRODUCTS table using a JOIN on ERP database tables I was able to update PRODUCTS prices, quantites and flags and subsequently call the update API once for each product with flag set to true.
6) I allowed for both manual and automatic syncronization. Manual by inserting a link to http://nopSync in the Admin panel menu and automatic by using a scheduled task to repeatedly call the web sample.

When the customer asked me, at the end of the day, how many days it would take to build the ERP syncronization, I said that thanks to SevenSpikes API plug it was online and syncronizing. Thanks SevenSpikes!!
Was this review helpful? Yes  No (7 / 0)
Very useful
a.m.
8/21/2017 6:17 AM
Maybe, the most useful plugin (API). Recommended by nopCommerce team!
Was this review helpful? Yes  No (2 / 0)
Would you provide us how to call the API or use it?
m.amer
7/21/2017 7:32 PM
Would you provide us how to call the API or use it?
Was this review helpful? Yes  No (0 / 0)
A vendor responded to this review
Please refer to the Sample Application - https://github.com/SevenSpikes/nopCommerce-Api-SampleApplication

It shows you how to authorize and make calls to the Api
what about using this plugin version with 3.6?
m.amer
7/20/2017 2:32 AM
what about using this plugin version with 3.6?
Was this review helpful? Yes  No (0 / 0)
A vendor responded to this review
The plugin is available only for nopCommerce 3.7 and above.
Where is the 3.9 version
surgum
4/1/2017 3:39 AM
Is there a version for 3.9?
Was this review helpful? Yes  No (0 / 0)
Must have if integrating custom software to your store
Figmo
2/11/2017 1:24 PM
Wow - this plugin rocks!  

Plus, the source code gives you a great place to expand it to do things it doesn't already do

I've already added GenericAttribute support and Search in product name/descriptions.

Worth it even at 100 times the price! <wink>
Was this review helpful? Yes  No (0 / 0)
Thanks for the free plugin
easyalioglu
1/24/2017 3:53 AM
Thanks for the free plugin.
Was this review helpful? Yes  No (0 / 0)
Very Useful
khalil_sandilkar
11/28/2016 12:11 AM
Very Useful Plugin.
Was this review helpful? Yes  No (0 / 0)
great thanks
vixu1128
11/23/2016 1:26 AM
It's helpful for us
Was this review helpful? Yes  No (0 / 0)
Great plugin
a.m.
11/22/2016 10:35 PM
This is a really very good plugin! Very useful (for any kind of integrations). And it's free! Recommended by nopCommerce team!
Was this review helpful? Yes  No (7 / 0)