Postman Package
Import into Postman to test all public REST endpoints against your installation.
Individual Files
| File | Format | Use |
|---|---|---|
| agents.html / agents.md | Markdown | AI agents — canonical machine-readable API reference |
| llms.txt | Plain text | Agent discovery index |
| for-agents.html | HTML | Agent landing page with instructions |
| RPM-PRO-API.postman_collection.json | Postman Collection v2.1 | Import → Collections |
| RPM-PRO-Local.postman_environment.json | Postman Environment | Import → Environments, set baseUrl and credentials |
| rpm-pro-api.openapi.yaml | OpenAPI 3.0 | Import into Postman, Swagger UI, or code generators |
Postman Setup
- Download and unzip the Postman package, or import the JSON files directly.
- In Postman: Import → select collection and environment files.
- Select the RPM PRO — Local environment.
- Set variables:
baseUrl— your site root (e.g.https://demo.rpm-pro.com)adminAPIKey/adminAPISecret— fromadminstable (for Admin Auth folder)tenantEmail/tenantPassword— for tenant auth tests
- Run Admin Auth → Admin Login first if testing admin session endpoints.
- For tenant endpoints, run Tenant Auth → Tenant Login (cookies are stored automatically).
Regenerate packages: After version bumps in
versions.html, run php bin/generate-api-docs.html from the project root to refresh zips and static exports.
# From project root (Docker)
docker compose exec app php bin/generate-api-docs.html
# Or local PHP
php bin/generate-api-docs.html