Skip to content

Commit 25865ea

Browse files
committed
docs: add API Endpoints section to README
1 parent f03c9b0 commit 25865ea

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,31 @@ $client->setWebhookHandler(function($event, $data) {
179179
$client->startWebhookListener();
180180
```
181181

182+
## 📚 API Endpoints
183+
184+
All endpoints automatically use the `/v1` prefix when connecting to `https://api.licensechain.app`.
185+
186+
### Base URL
187+
- **Production**: `https://api.licensechain.app/v1`
188+
- **Development**: `https://api.licensechain.app/v1`
189+
190+
### Available Endpoints
191+
192+
| Method | Endpoint | Description |
193+
|--------|----------|-------------|
194+
| `GET` | `/v1/health` | Health check |
195+
| `POST` | `/v1/auth/login` | User login |
196+
| `POST` | `/v1/auth/register` | User registration |
197+
| `GET` | `/v1/apps` | List applications |
198+
| `POST` | `/v1/apps` | Create application |
199+
| `GET` | `/v1/licenses` | List licenses |
200+
| `POST` | `/v1/licenses/verify` | Verify license |
201+
| `GET` | `/v1/webhooks` | List webhooks |
202+
| `POST` | `/v1/webhooks` | Create webhook |
203+
| `GET` | `/v1/analytics` | Get analytics |
204+
205+
**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`).
206+
182207
## 📚 API Reference
183208

184209
### LicenseChainClient

0 commit comments

Comments
 (0)