Stefan Lazic
090646fdfd
Base app architecture:
Route groups for customer, staff and owner.
* Reusable design system with around 20 UI components.
* Complete Prisma schema.
* Authentication with email/password and Google.
* Role and permission model.
* Protected routes.
* Clean separation between features, services, components and shared utilities.
70 lines
2.2 KiB
Markdown
70 lines
2.2 KiB
Markdown
# management-api
|
|
|
|
Use Prisma Management API for programmatic provisioning and workspace/project/database management.
|
|
|
|
## Priority
|
|
|
|
CRITICAL
|
|
|
|
## Why It Matters
|
|
|
|
When you need backend automation, multi-tenant onboarding flows, or controlled resource provisioning, the Management API is the source of truth and is more reliable than interactive workflows.
|
|
|
|
## Base URL
|
|
|
|
```text
|
|
https://api.prisma.io/v1
|
|
```
|
|
|
|
## API exploration
|
|
|
|
- OpenAPI docs: `https://api.prisma.io/v1/doc`
|
|
- Swagger Editor: `https://api.prisma.io/v1/swagger-editor`
|
|
|
|
## Authentication methods
|
|
|
|
- Service token: best for server-to-server operations in your own workspace
|
|
- OAuth 2.0: best for acting on behalf of users across workspaces
|
|
|
|
## Service token flow
|
|
|
|
1. Create token in Prisma Console workspace settings.
|
|
2. Send token as Bearer auth:
|
|
|
|
```text
|
|
Authorization: Bearer $TOKEN
|
|
```
|
|
|
|
## OAuth flow summary
|
|
|
|
1. Redirect user to `https://auth.prisma.io/authorize` with `client_id`, `redirect_uri`, `response_type=code`, and scopes.
|
|
2. Receive `code` on callback.
|
|
3. Exchange code at `https://auth.prisma.io/token`.
|
|
4. Use returned access token in Management API requests.
|
|
|
|
## Resource model
|
|
|
|
Workspace -> Project -> Branch -> Database. Branches are a first-class resource: databases attach to a Branch, and branch-scoped env/databases are how preview isolation works.
|
|
|
|
## Common endpoints
|
|
|
|
- `GET /workspaces`
|
|
- `GET /projects`
|
|
- `POST /projects`
|
|
- `GET`/`POST /projects/:projectId/branches`
|
|
- `GET`/`PATCH`/`DELETE /branches/:branchId`
|
|
- Databases at both `/databases` (flat) and `/projects/:projectId/databases`
|
|
- Connection responses return structured `endpoints.direct` and `endpoints.pooled` objects; the flat top-level `connectionString` is deprecated in favor of `endpoints.direct.connectionString`/`endpoints.pooled.connectionString`
|
|
- Connection secrets are one-time view: revealed at creation, never re-readable from later GETs
|
|
|
|
## Notes
|
|
|
|
- Management API responses may include direct connection credentials for databases.
|
|
- Build PostgreSQL `DATABASE_URL` from direct connection values when needed.
|
|
|
|
## References
|
|
|
|
- [Management API docs](https://www.prisma.io/docs/postgres/introduction/management-api)
|
|
- [OpenAPI docs](https://api.prisma.io/v1/doc)
|
|
- [Swagger Editor](https://api.prisma.io/v1/swagger-editor)
|