@@ -11,17 +11,25 @@ Altus 4 provides a RESTful API for managing database connections, executing sear
1111
1212## Authentication
1313
14- All API endpoints require API key authentication for B2B service integration.
14+ Altus 4 uses ** dual authentication** depending on the endpoint type:
15+
16+ - ** JWT Tokens** : For user management, account operations, API key management, database management, and analytics
17+ - ** API Keys** : For search operations and B2B service integration
1518
1619### Authentication Flow
1720
18211 . ** Register** a new user account
19- 2 . ** Create** your first API key using the management endpoint
20- 3 . ** Include API key** in ` Authorization ` header for all subsequent requests
22+ 2 . ** Login** to receive a JWT token
23+ 3 . ** Create** your first API key using the JWT token
24+ 4 . ** Use JWT tokens** for account management (profile, API key management)
25+ 5 . ** Use API keys** for search operations and analytics
2126
2227``` bash
23- # Include API key in all requests
24- Authorization: Bearer < your-api-key>
28+ # Use JWT token for account management
29+ Authorization: Bearer < jwt-token>
30+
31+ # Use API key for search operations
32+ Authorization: Bearer < api-key>
2533```
2634
2735** API Key Format** : ` altus4_sk_live_abc123def456... ` (live) or ` altus4_sk_test_xyz789abc123... ` (test)
@@ -40,12 +48,12 @@ Authorization: Bearer <your-api-key>
4048| ` DELETE ` | ` /api/v1/auth/account ` | Deactivate account | JWT Token | Tested |
4149| ` POST ` | ` /api/v1/management/setup ` | Create first API key | JWT Token | Tested |
4250| ` GET ` | ` /api/v1/management/migration-status ` | Check migration status | JWT Token | Tested |
43- | ` POST ` | ` /api/v1/keys ` | Create new API key | API Key | Requires admin permission |
44- | ` GET ` | ` /api/v1/keys ` | List API keys | API Key | Tested |
45- | ` PUT ` | ` /api/v1/keys/:keyId ` | Update API key | API Key | Requires admin permission |
46- | ` DELETE ` | ` /api/v1/keys/:keyId ` | Revoke API key | API Key | Requires admin permission |
47- | ` GET ` | ` /api/v1/keys/:keyId/usage ` | Get API key usage stats | API Key | Not tested |
48- | ` POST ` | ` /api/v1/keys/:keyId/regenerate ` | Regenerate API key | API Key | Requires admin permission |
51+ | ` POST ` | ` /api/v1/keys ` | Create new API key | JWT Token | Requires admin permission |
52+ | ` GET ` | ` /api/v1/keys ` | List API keys | JWT Token | Tested |
53+ | ` PUT ` | ` /api/v1/keys/:keyId ` | Update API key | JWT Token | Requires admin permission |
54+ | ` DELETE ` | ` /api/v1/keys/:keyId ` | Revoke API key | JWT Token | Requires admin permission |
55+ | ` GET ` | ` /api/v1/keys/:keyId/usage ` | Get API key usage stats | JWT Token | Not tested |
56+ | ` POST ` | ` /api/v1/keys/:keyId/regenerate ` | Regenerate API key | JWT Token | Requires admin permission |
4957
5058[ ** → Complete API Key Authentication Guide** ] ( ./authentication.md )
5159
@@ -78,7 +86,7 @@ Execute searches across connected databases with AI enhancements.
7886| ------ | ---------------------------- | ------------------------- | ------------------- | ---------- |
7987| ` POST ` | ` /api/v1/search ` | Execute search | API Key | Tested |
8088| ` GET ` | ` /api/v1/search/suggestions ` | Get search suggestions | API Key | Tested |
81- | ` POST ` | ` /api/v1/search/analyze ` | Analyze query performance | API Key (analytics) | Not tested |
89+ | ` POST ` | ` /api/v1/search/analyze ` | Analyze query performance | API Key (analytics) | Tested |
8290| ` GET ` | ` /api/v1/search/history ` | Get search history | API Key | Tested |
8391| ` GET ` | ` /api/v1/search/trends ` | Get user search trends | API Key (analytics) | Tested |
8492
@@ -159,7 +167,7 @@ interface ApiResponse<T> {
159167 "meta" : {
160168 "timestamp" : " 2025-09-06T16:19:56.197Z" ,
161169 "requestId" : " 1b53d9d6-ca2e-4b99-959b-8459820475b4" ,
162- "version" : " 0.1 .0"
170+ "version" : " 0.3 .0"
163171 }
164172}
165173```
@@ -185,7 +193,7 @@ interface ApiResponse<T> {
185193 "meta" : {
186194 "timestamp" : " 2025-09-06T16:20:01.403Z" ,
187195 "requestId" : " fb62455b-8ccd-4cbb-898a-606ba936e25c" ,
188- "version" : " 0.2.1 "
196+ "version" : " 0.3.0 "
189197 }
190198}
191199```
@@ -206,7 +214,7 @@ interface ApiResponse<T> {
206214 "meta" : {
207215 "timestamp" : " 2024-01-15T10:30:00.000Z" ,
208216 "requestId" : " req_abc123" ,
209- "version" : " 0.1 .0"
217+ "version" : " 0.3 .0"
210218 }
211219}
212220```
@@ -467,4 +475,4 @@ The Altus4 Core API is now fully functional and ready for production deployment.
467475
468476---
469477
470- ** Need help?** Check out the [ examples section] ( ../examples/ ) for practical implementations or [ report issues] ( https://github.com/altus4/core /issues ) if you find any problems.
478+ ** Need help?** Check out the [ examples section] ( ../examples/ ) for practical implementations or [ report issues] ( https://github.com/anthropics/claude-code /issues ) if you find any problems.
0 commit comments