VibeMobi Favorite Number Management API Documentation
This documentation provides comprehensive information about the VibeMobi Favorite Number Management API. It includes endpoint details, authentication mechanisms, request/response structures, and best practices for integration.
Overview
The VibeMobi Favorite Number Management API allows you to programmatically manage favorite numbers for customers through a RESTful API interface. This documentation will guide you through the process of:
- Authenticating with the API
- Managing users and user accounts
- Managing customer favorite numbers
- Working with plans and settings
- Handling responses and errors
Base URL
All API endpoints are relative to the base URL:
Quick Start
To get started with the VibeMobi API:
- Generate an access token using your credentials
- Use the token to access protected endpoints
- Process responses and handle errors appropriately
API Endpoints Overview
Authentication
| Endpoint | Method | Description |
|---|---|---|
/v1/login/access-token |
POST | Generate authentication token |
/v1/login/test-token |
POST | Test access token validity |
/v1/password-recovery/{email} |
POST | Initiate password recovery |
/v1/reset-password/ |
POST | Reset password with token |
Users
| Endpoint | Method | Description |
|---|---|---|
/v1/users/ |
GET | List users (paginated) |
/v1/users/ |
POST | Create new user |
/v1/users/me |
GET | Get current user profile |
/v1/users/me |
PATCH | Update current user profile |
/v1/users/me |
DELETE | Delete current user account |
/v1/users/me/password |
PATCH | Update current user password |
/v1/users/signup |
POST | Register new user (public) |
/v1/users/{user_id} |
GET | Get user by ID |
/v1/users/{user_id} |
PATCH | Update user by ID |
/v1/users/{user_id} |
DELETE | Delete user by ID |
Favorites
| Endpoint | Method | Description |
|---|---|---|
/v1/favorites/customer-info/{customer_phone_number} |
GET | Get customer information |
/v1/favorites/ |
POST | Add favorite number |
/v1/favorites/ |
PUT | Update favorite label |
/v1/favorites/ |
DELETE | Remove favorite number |
/v1/favorites/check |
GET | Check if number is favorite |
/v1/favorites/{customer_phone} |
GET | Get customer's favorites |
Plans
| Endpoint | Method | Description |
|---|---|---|
/v1/plans/ |
GET | List all plans |
/v1/plans/ |
POST | Create new plan |
/v1/plans/{plan_id} |
GET | Get plan by ID |
/v1/plans/{plan_id} |
PUT | Update plan |
/v1/plans/{plan_id} |
DELETE | Delete plan |
Settings
| Endpoint | Method | Description |
|---|---|---|
/v1/settings/ |
GET | List all settings |
/v1/settings/ |
POST | Create new setting |
/v1/settings/{key} |
GET | Get setting by key |
/v1/settings/{key} |
PUT | Update setting |
/v1/settings/{key} |
DELETE | Delete setting |
Authentication
Most endpoints require authentication using OAuth2 Bearer tokens. See the Authentication section for detailed information on how to obtain and use access tokens.
Error Handling
The API uses standard HTTP status codes and returns JSON error responses. Common error codes include:
200- Success201- Created400- Bad Request401- Unauthorized403- Forbidden404- Not Found409- Conflict422- Validation Error500- Internal Server Error
Rate Limiting
Please be mindful of API rate limits to ensure optimal performance for all users. Contact support if you need higher rate limits for your application.
Need Help?
If you encounter any issues or have questions about the API, please contact our support team or refer to the Best Practices section for common implementation patterns.