> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rebellapp.com/llms.txt
> Use this file to discover all available pages before exploring further.
# JSAPI Overview
> Introduction to the JavaScript APIs available for Mini Program development.
The framework provides developers with **JSAPI and OpenAPI capabilities** to launch diversified convenient services to users. This section covers the client-side JavaScript APIs (JSAPI) that Mini Apps can use to interact with the platform and device features.
## API Patterns
Mini Program JSAPIs follow two main patterns:
### Event Listening APIs
APIs prefixed with `my.on` listen to system events and accept callback functions. When the event is triggered, the callback is executed.
```javascript theme={null}
// Register event listener
my.onAppShow((res) => {
console.log('App became visible', res);
});
// Unregister specific listener
my.offAppShow(callback);
// Unregister all listeners for an event
my.offAppShow();
```
Always clean up event listeners when they're no longer needed, such as in page `onUnload` lifecycle hooks, to prevent memory leaks.
### Standard Interface APIs
Most other APIs accept an object as a parameter and support three callback types:
| Callback | Description |
| ---------- | ------------------------------------------------ |
| `success` | Called when the operation completes successfully |
| `fail` | Called when the operation fails |
| `complete` | Always called after success or fail |
```javascript theme={null}
my.getLocation({
success: (res) => {
console.log('Location:', res.latitude, res.longitude);
},
fail: (err) => {
console.error('Failed:', err.errorMessage);
},
complete: () => {
console.log('Operation finished');
}
});
```
### Promise Support
APIs also return Promise objects, allowing both callback and async/await patterns:
```javascript theme={null}
// Using Promise .then()
my.request({
url: 'https://api.example.com/data'
}).then((res) => {
console.log('Success:', res.data);
}).catch((err) => {
console.error('Error:', err.errorMessage);
});
// Using async/await
async function fetchData() {
try {
const res = await my.request({
url: 'https://api.example.com/data'
});
console.log('Success:', res.data);
} catch (err) {
console.error('Error:', err.errorMessage);
}
}
```
## API Categories
Core APIs for version checking and feature detection
App lifecycle and error event handling
Navigation, feedback, dialogs, and UI controls
Image, video, and animation handling
Local data persistence
File system operations
Geolocation services
Map integration and routing
HTTP requests and WebSocket connections
Hardware and system information
Content sharing capabilities
App update management
WebView integration
Authentication, payments, and cross-app navigation
## Feature Detection
Before using an API, you can check if it's supported in the current environment:
```javascript theme={null}
if (my.canIUse('getLocation')) {
my.getLocation({
success: (res) => {
console.log(res);
}
});
} else {
console.log('getLocation is not supported');
}
```
Always use feature detection for APIs that may not be available on all platform versions. This ensures your Mini App degrades gracefully on older versions.
## Next Steps
Complete API reference by category
Cross-app launch integration