unopim-api
Installation
SKILL.md
UnoPim REST API (AdminApi v1)
The REST API is packages/Webkul/AdminApi: Passport password-grant tokens issued to admin users, a per-key permission tree in api-acl, and a list engine (ApiDataSource) that owns pagination, filters and the response envelope. It is NOT a Laravel routes/api.php + apiResource + JsonResource::collection API. Copy the shape of an existing endpoint before writing a line.
REQUIRED BACKGROUND: unopim-standards for idiom, security, scale, localization and comments. unopim-exec before any artisan, pest or composer command. unopim-verify before calling anything done. A new package or connector scaffold: unopim-plugin-development.
Reference files
| File | Read when |
|---|---|
| endpoint-recipe.md | Adding an endpoint end to end: route, api-acl entry, DataSource, controller, FormRequest, translations, permission backfill |
| auth-acl.md | Tokens, integrations, api.scope semantics, the two passport commands, rate limits, a 401/403/406 you cannot explain |
| contract.md | Response envelopes, pagination (page and search_after), the filters JSON grammar, error codes, structure cache and ETag |
| testing.md | Pest tests with ApiTestCase / ApiHelperTrait, ACL tests, what every endpoint test must cover |