Skip to content

Commit f14c2ee

Browse files
committed
docs: move API endpoints section before client reference
1 parent c6c48d4 commit f14c2ee

1 file changed

Lines changed: 29 additions & 32 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,35 @@ client.setWebhookHandler((event, data) => {
186186
await client.startWebhookListener();
187187
```
188188

189-
## 📚 API Reference
189+
## 📚 API Endpoints
190+
191+
All endpoints target the LicenseChain HTTP API at `https://api.licensechain.app/v1`. The client accepts either the canonical `/v1` base or the root host and normalizes requests to the same API version.
192+
193+
### Base URL
194+
195+
- **Production**: `https://api.licensechain.app/v1`
196+
- **Development**: `https://api.licensechain.app/v1`
197+
198+
### Available Endpoints
199+
200+
| Method | Endpoint | Description |
201+
| -------- | ---------- | --------------- |
202+
| GET | /v1/health | Health check |
203+
| POST | /v1/auth/login | User login |
204+
| POST | /v1/auth/register | User registration |
205+
| GET | /v1/apps | List applications |
206+
| POST | /v1/apps | Create application |
207+
| GET | /v1/licenses | List licenses |
208+
| POST | /v1/licenses/verify | Verify license |
209+
| GET | /v1/webhooks | List webhooks |
210+
| POST | /v1/webhooks | Create webhook |
211+
| GET | /v1/analytics | Get analytics |
212+
213+
**Note:** The SDK automatically prepends `/v1` to all endpoints, so you only need to specify the path (e.g., `/auth/login` instead of `/v1/auth/login`).
214+
215+
## API Reference
216+
217+
See the [LicenseChain SDK docs](https://docs.licensechain.app/en/sdk) for full HTTP and client method reference. Repository examples and inline docs cover language-specific usage.
190218

191219
### LicenseChain Client
192220

@@ -478,34 +506,3 @@ This project is licensed under the Elastic License 2.0 (ELv2) — see the [LICEN
478506
---
479507

480508
**Made with ❤️ for the JavaScript community**
481-
482-
483-
## 📚 API Endpoints
484-
485-
All endpoints target the LicenseChain HTTP API at `https://api.licensechain.app/v1`. The client accepts either the canonical `/v1` base or the root host and normalizes requests to the same API version.
486-
487-
### Base URL
488-
489-
- **Production**: `https://api.licensechain.app/v1`
490-
- **Development**: `https://api.licensechain.app/v1`
491-
492-
### Available Endpoints
493-
494-
| Method | Endpoint | Description |
495-
| -------- | ---------- | --------------- |
496-
| GET | /v1/health | Health check |
497-
| POST | /v1/auth/login | User login |
498-
| POST | /v1/auth/register | User registration |
499-
| GET | /v1/apps | List applications |
500-
| POST | /v1/apps | Create application |
501-
| GET | /v1/licenses | List licenses |
502-
| POST | /v1/licenses/verify | Verify license |
503-
| GET | /v1/webhooks | List webhooks |
504-
| POST | /v1/webhooks | Create webhook |
505-
| GET | /v1/analytics | Get analytics |
506-
507-
**Note:** The SDK automatically prepends `/v1` to all endpoints, so you only need to specify the path (e.g., `/auth/login` instead of `/v1/auth/login`).
508-
509-
## API Reference
510-
511-
See the [LicenseChain SDK docs](https://docs.licensechain.app/en/sdk) for full HTTP and client method reference. Repository examples and inline docs cover language-specific usage.

0 commit comments

Comments
 (0)