Skip to content

Commit c6c48d4

Browse files
committed
docs: restructure README footer API sections
Replace LicenseChain API (v1) with rendered API Endpoints table and concise API Reference.
1 parent db14b2e commit c6c48d4

1 file changed

Lines changed: 28 additions & 37 deletions

File tree

‎README.md‎

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

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-
- **Production**: `https://api.licensechain.app/v1`
195-
- **Development**: `https://api.licensechain.app/v1`
196-
197-
### Available Endpoints
198-
199-
| Method | Endpoint | Description |
200-
|--------|----------|-------------|
201-
| `GET` | `/v1/health` | Health check |
202-
| `POST` | `/v1/auth/login` | User login |
203-
| `POST` | `/v1/auth/register` | User registration |
204-
| `GET` | `/v1/apps` | List applications |
205-
| `POST` | `/v1/apps` | Create application |
206-
| `GET` | `/v1/licenses` | List licenses |
207-
| `POST` | `/v1/licenses/verify` | Verify license |
208-
| `GET` | `/v1/webhooks` | List webhooks |
209-
| `POST` | `/v1/webhooks` | Create webhook |
210-
| `GET` | `/v1/analytics` | Get analytics |
211-
212-
**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`).
213-
214189
## 📚 API Reference
215190

216191
### LicenseChain Client
@@ -504,17 +479,33 @@ This project is licensed under the Elastic License 2.0 (ELv2) — see the [LICEN
504479

505480
**Made with ❤️ for the JavaScript community**
506481

507-
## LicenseChain API (v1)
508482

509-
This SDK targets the **LicenseChain HTTP API v1** implemented by the LicenseChain API service.
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.
510486

511-
- **Production base URL:** https://api.licensechain.app/v1
512-
- **API reference:** [docs.licensechain.app](https://docs.licensechain.app/)
513-
- **Baseline REST mapping (documented for integrators):**
514-
- GET /health
515-
- POST /auth/register
516-
- POST /licenses/verify
517-
- PATCH /licenses/:id/revoke
518-
- PATCH /licenses/:id/activate
519-
- PATCH /licenses/:id/extend
520-
- GET /analytics/stats
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)