Introduction - Public RESTful API

Use the NopAdvance RESTful API to seamlessly integrate nopCommerce front-end methods into mobile applications, headless websites, or other platforms, providing a streamlined development experience.

Adhering strictly to nopCommerce standards, this API employs native services and methods right out of the box, ensuring a secure and efficient integration. Designed with ease of use and flexibility in mind, our API plugin is not only easy to configure but also extendable without the need for API plugin source code.

It leverages JWT for authentication and aligns with the latest security benchmarks established by nopCommerce, making it an ideal solution for developers looking to build sophisticated e-commerce solutions seamlessly across various platforms.

Our RESTful API not only simplifies the integration of nopCommerce front-end methods but also introduces robust features for enhanced maintainability, control, and development flexibility. Check our swagger documentation on live demo.

Features & Benefits:

1. Seamless Extension: Extend existing functionality using partial classes without purchasing source code.
2. Developer-Friendly Tools: Comprehensive Swagger documentation & User Guide for accelerated development.
3. Optimized Performance: Leverages response compression and server-side caching for swift responses.
4. Multi-Store Capability: A single plugin facilitates the use across multiple stores and applications.
5. Robust Security: Features multi-layered authentication, secure JWT handling, and unique API keys for each application, enhancing security without storing access tokens in the database.
6. Efficient Logging and Maintenance: Enables detailed request/response logging and efficient token management to optimize database performance.
7. Comprehensive nopCommerce Integration: Full support for nopCommerce customer activity logs and front-end methods, including customer impersonation and guest customer migration.
8. Extensive API Coverage: Over 200 API methods available, covering the entire nopCommerce front-end spectrum.
9. Exclusive Developer Perks: Includes a development mode for API testing, supports refresh token mechanisms, and offers free upgrades for one year post-purchase.
10. Efficient Maintenance: Implement a cleanup operation with the option to delete expired tokens, optimizing database space and performance.
11. Full Administrative Oversight: Administrators gain unparalleled control over the API's usage:
    • View a comprehensive list of active customer tokens, equipped with intuitive search capabilities and filters for easy management.
    • Ability to revoke any customer token(s) instantly, ensuring unauthorized access can be swiftly mitigated.
12. Flexible Development Mode: Tailor the API's behavior to suit development needs without compromising security or functionality.
    • Certain methods that do not require a signed-in user can operate without an API key, facilitating easier testing and integration.
    • The system is designed to avoid the creation of guest users and unnecessary access tokens, streamlining the user experience and maintaining database cleanliness.
    • Utilizes the default "builtin@search_engine_record.com" customer record out-of-the-box, simplifying initial setup and testing processes.

The plugin menu comprises four distinct items, each serving a specific function within the plugin's ecosystem:

1. Configure Page: This section is where you can tailor the plugin's settings to your needs. It provides options to enable or disable the plugin and its features. This centralized configuration hub ensures that the plugin operates in harmony with your site's requirements.
2. Applications Page: Here, you have the capability to create and oversee applications for each store. Each application is equipped with a unique API key, enabling distinct and secure interactions with the plugin. This organization facilitates the management of multiple applications across different stores, ensuring that each operates effectively and securely.
3. Active Tokens Page: This page offers a view into the active customers associated with each application. It allows for the filtering of active customers and the ability to revoke access for one or more customers. This control mechanism is crucial for maintaining the security and integrity of the application access.
4. Debug Log Page: If debugging is enabled in the plugin's configuration, this section will display a detailed log of all requests and their responses in a tabular format. This visibility into the plugin's operation is invaluable for troubleshooting and ensuring that the API interactions are performing as expected.

Each of these menu items plays a vital role in the comprehensive management and operation of the plugin, providing administrators with the tools they need to efficiently manage their API ecosystem.

Designed with developers in mind, our REST API for nopCommerce not only simplifies the integration process but also opens up a world of possibilities for e-commerce innovation. Whether you're building a new mobile app or a cutting-edge headless e-commerce site, our plugin is the tool you need to bring your vision to life efficiently and securely.

These enhancements ensure that developers have the tools and controls necessary for efficient development, maintenance, and administration of their e-commerce platforms, aligning with the principles of security, efficiency, and user experience.