6ec8d3236d
- Replace TLAS with License Authority throughout documentation - Add Government of Goa emblem/logo (Ashoka Chakra style) - Update frontend branding to match documentation - Add configurable Swagger API link via VITE_API_BASE_URL env var - Fix Docker build for VitePress (git dependency, .dockerignore) - Fix helmet security headers for HTTP deployments - Add CORS support for VM deployment Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
118 lines
2.6 KiB
Markdown
118 lines
2.6 KiB
Markdown
# API Documentation
|
|
|
|
## Overview
|
|
|
|
The platform provides REST APIs for integrating with external systems. All APIs use JSON for request and response bodies.
|
|
|
|
## Base URL
|
|
|
|
```
|
|
Production: https://api.license.gov.in/v1
|
|
Staging: https://api-staging.license.gov.in/v1
|
|
```
|
|
|
|
## Interactive API Documentation
|
|
|
|
Explore and test APIs using our interactive Swagger UI:
|
|
|
|
**<ApiDocsLink />**
|
|
|
|
The Swagger documentation provides:
|
|
- Complete endpoint specifications
|
|
- Request/response schemas
|
|
- Interactive "Try it out" functionality
|
|
- Authentication testing
|
|
|
|
## Authentication
|
|
|
|
All API requests require authentication via Bearer token.
|
|
|
|
```http
|
|
Authorization: Bearer <access_token>
|
|
```
|
|
|
|
Obtain tokens through the authentication endpoint. See [Authentication](/developers/authentication) for details.
|
|
|
|
## Request Format
|
|
|
|
```http
|
|
POST /applications HTTP/1.1
|
|
Host: api.license.gov.in
|
|
Authorization: Bearer eyJhbGc...
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
## Response Format
|
|
|
|
### Success Response
|
|
|
|
```json
|
|
{
|
|
"success": true,
|
|
"data": {
|
|
"id": "APP-2026-00001",
|
|
"status": "SUBMITTED"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Error Response
|
|
|
|
```json
|
|
{
|
|
"success": false,
|
|
"error": {
|
|
"code": "VALIDATION_ERROR",
|
|
"message": "Invalid license type",
|
|
"details": [
|
|
{ "field": "licenseType", "message": "Must be one of: TRADE_LICENSE, FOOD_LICENSE" }
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Rate Limits
|
|
|
|
| Tier | Requests/minute | Burst |
|
|
|------|-----------------|-------|
|
|
| Standard | 60 | 100 |
|
|
| Premium | 300 | 500 |
|
|
|
|
Rate limit headers included in all responses:
|
|
```http
|
|
X-RateLimit-Limit: 60
|
|
X-RateLimit-Remaining: 45
|
|
X-RateLimit-Reset: 1707500000
|
|
```
|
|
|
|
## API Endpoints
|
|
|
|
| Category | Endpoint | Description |
|
|
|----------|----------|-------------|
|
|
| Auth | `POST /auth/token` | Obtain access token |
|
|
| Applications | `POST /applications` | Submit new application |
|
|
| Applications | `GET /applications/:id` | Get application status |
|
|
| Documents | `POST /documents/upload` | Upload document |
|
|
| Verification | `GET /verify/:tokenId` | Verify certificate |
|
|
|
|
## SDKs
|
|
|
|
Official SDKs available:
|
|
- JavaScript/TypeScript: `npm install @license-authority/sdk`
|
|
- Python: `pip install license-authority-sdk`
|
|
- Java: Maven artifact `gov.in.license:license-authority-sdk`
|
|
|
|
## Documentation
|
|
|
|
- [Authentication](/developers/authentication) - Token management
|
|
- [Core APIs](/developers/core-apis) - Application and document APIs
|
|
- [Blockchain APIs](/developers/blockchain-apis) - Certificate verification
|
|
- [Webhooks](/developers/webhooks) - Event notifications
|
|
- [Error Handling](/developers/errors) - Error codes and handling
|