Exsited API Documentation
Welcome to Exsited API
The Exsited API empowers developers to build robust integrations with our comprehensive business management platform. Our REST API provides secure and seamless access to all core business functions, including accounts, billing, orders, payments, events, and more.
Getting Started
Step 1: Obtain API Access
Before using the Exsited API, you need credentials and configuration details from the Exsited team:
- API Base URL: Your unique endpoint (e.g.,
https://example.exsited.com/v3) - API Credentials:
client_idandclient_secret - Redirect URI: Required for OAuth 2.0 authentication
Once you receive these details, you can request an access token to authenticate API calls:
Step 2: Authenticate
Obtain an access token using the OAuth 2.0 Client Credentials flow.
curl -X POST https://example.exsited.com/api/v1/oauth2/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"redirect_uri": "your_redirect_uri"
}'Step 3: Make Your First Request
curl -X GET https://example.exsited.com/v3/accounts \
-H "Authorization: Bearer your_access_token"General Endpoint Structure
The Exsited API provides CRUD operations for all main resources such as Accounts, Items, Orders, Payments, Invoices, and more.
| Operation | HTTP Method | URL Pattern | Description |
|---|---|---|---|
| List Resources | GET | /api/v3/{resource} |
Retrieve a list of resources (e.g., accounts, orders) |
| Retrieve Resource | GET | /api/v3/{resource}/{id} |
Get detailed information for a single resource |
| Create Resource | POST | /api/v3/{resource} |
Create a new resource |
| Update Resource | PUT | /api/v3/{resource}/{id} |
Update an existing resource |
| Delete Resource | DELETE | /api/v3/{resource}/{id} |
Delete a resource |
Core API Resources
Authentication
- Endpoint:
POST /api/v1/oauth2/token - Purpose: Generate access tokens for API calls
Account Management
Manage the complete customer account lifecycle.
- Endpoints:
GET /api/v3/accounts– List all accountsGET /api/v3/accounts/{id}– Retrieve account detailsPOST /api/v3/accounts– Create a new accountPUT /api/v3/accounts/{id}– Update an existing accountDELETE /api/v3/accounts/{id}– Delete an account
Item Management
Manage products and service catalog.
- Features: CRUD operations, pricing control, categorization
Order Processing
End-to-end order lifecycle management.
- Features: Order creation, updates, tracking, fulfillment
Usage Tracking
Track service consumption for billing and reporting.
- Benefits: Accurate billing, analytics, usage reports
Invoice Management
Comprehensive billing and invoicing.
- Features: Invoice creation, auto-generation, status tracking, credit notes
Payment Processing
Secure payments with multiple methods.
- Features: Payment methods, transaction history, refunds
- Compliance: PCI-DSS
Settings Management
Manage system and user configuration.
- Scope: Organization-wide and user-specific
Event Management
Real-time event logging and notifications.
- Use Cases: Audit trails, workflow triggers, monitoring
Webhook Management
Deliver real-time updates to external systems.
- Features: Event registration, delivery tracking
Notes Management
Manage notes and attachments.
- Use Cases: Customer communication, documentation
Reporting
Business intelligence and analytics.
- Reports: Accounts, invoices, orders, payments
- Features: Filtering, customization
API Usage Patterns
Pagination
For endpoints returning collections:
GET /api/v3/accounts?limit=20&offset=0&order_by=created_on&direction=descError Responses
Errors are returned with standard HTTP status codes and detailed messages.
Example:
{
"error": "invalid_request",
"error_description": "Missing required parameter: client_id"
}Status Codes
| Code | Status |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Error |