Skip to main content

Introduction to API Integration – Mini AI

The MiniAI Commerce API system provides a powerful set of tools that help businesses and developers easily integrate, manage, and automate business operations.

Through the API, customers can manage messages, templates, products, orders, and news in a unified, secure, and fast manner.

The API is designed following RESTful standards, transmitting data in JSON format, ensuring security, stability, and scalability.

Key Features of MiniAI Commerce API​

Through the API, customers can manage the following important tasks:

  • Messages & Templates: Create, send, and manage message templates effectively for communication campaigns.
  • Products: Update product information and categories flexibly, ensuring data is always synchronized.
  • Orders: Process and track order statuses quickly, enhancing customer experience.
  • News: Manage news content and articles professionally, helping to update information promptly.

All these features are designed to operate in a unified – secure – fast manner, optimizing operational processes and increasing business efficiency.

Standardization & Security​

MiniAI Commerce's API is built following RESTful standards, easily integrating with existing systems. Data is transmitted in JSON format – a format that is lightweight, readable, and easy to process.

We are committed to ensuring our API system always guarantees: Security - Stability - Scalability

MiniAI Commerce API Usage Guide​

1. Methods & Formats​

  • Using REST API: Standard protocol, familiar to developers.
  • Data format: All response data is in JSON format.
  • Supported environments:
    • Staging: MiniAI Commerce's testing environment.
    • Production: Official deployment environment for real-world applications.

2. API Authentication​

Every request sent to the API requires the following authentication header:

Header
x-api-key = "miniai-partner " + {secret-key}
  • Where secretkey is issued individually to each customer.
  • This key must be kept strictly confidential and not shared publicly.

3. Base URL​

Base URL - Staging
https://staging-manage.api.miniai.vn/api/external
Base URL - Production
https://manage-api.miniap.vn/api/external

4. List of Supported MiniAI Commerce APIs​