Business concepts
What is the Appmax API?
The Appmax API allows you to create and manage customers, orders, payments, and other essential resources for running a store. It is designed so that developers can integrate efficiently, ensuring security and flexibility through the creation of an application.
Application types
Ideal for developers who want to integrate and process sales exclusively in their own environments. This type of app is not publicly available in the Appmax directory and can only be accessed through a link shared by the developer.
It allows partners to create custom solutions without exposing them to the public, ensuring a more secure, exclusive, and optimized experience.
| Characteristic | Public application | Private application |
|---|---|---|
| AppStore visibility | Visible to all users | Not listed; access only via exclusive link |
| Access method | Available on the official Appmax App Store page | Access only through a sharing link |
| Installation | Direct installation from the Appmax App Store | Installed through a link shared by the developer |
AppStore benefits
- Customization of the store experience.
- Integration with external services.
- Adding features directly to the admin panel.
Security
- API access is restricted by key pairs.
- Keys are issued during app installation and must be stored securely.
- The use of temporary tokens ensures that credentials are not exposed in requests.
Mandatory technical requirements
| Requirement | Description |
|---|---|
| Authentication | Follow the authentication and authorization flow described in the documentation |
| Appmax JS security | Implement Appmax.js on the front end to protect sensitive card data |
| Customer creation | Register the buyer's data before creating orders |
| Order creation | Register the purchase linked to a customer |
| Payments | Process payments via credit card, Pix, boleto, or Apple Pay |
| Installment calculation | Query the installments endpoint to ensure correct amounts |
| Payment refunds | Implement refunds via API or dashboard |
| Tracking code | Update orders with tracking codes to enable withdrawal |
| Webhooks | Receive event notifications in real time |
Optional features
- Recurring billing: automatic periodic charges (beta).
- API payment link: URL for quick payment without a full cart (beta).
- Upsell: complementary sales strategy linked to existing orders.
- AI-powered sales recovery: abandoned cart recovery using artificial intelligence (beta).