markdowneditor

API Reference

REST endpoint docs – params, errors, examples

Phần mềm & Kỹ thuậtChuẩnapireference
Mở trong editorTải .md

Cách dùng: Public/partner APIs. Keep request/response examples real – copy from actual responses.

Xem trước

API Reference

Base URL: https://api.example.com/v1

Authentication: Authorization: Bearer <token>

Endpoints

GET /items

List items.

Query parameters

NameTypeRequiredDescription
limitintnoMax results (default 20, max 100)
cursorstringnoPagination cursor
filterstringnoFilter expression

Response 200

{
  "items": [{"id": "it_123", "name": "Example"}],
  "nextCursor": "eyJpZCI6..."
}

POST /items

Create an item.

Body

{
  "name": "string (required)",
  "description": "string (optional)"
}

Response 201 – the created item object.

Errors

CodeMeaning
400Invalid body
401Missing or invalid token
429Rate limited – respect Retry-After

Rate limits

100 requests/minute per token. Exceeding returns 429.

Changelog

VersionDateChange
v12026-01-01Initial release

Template liên quan