Download the PHP package flowrise-hms/api without Composer
On this page you can find all versions of the php package flowrise-hms/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download flowrise-hms/api
More information about flowrise-hms/api
Files in flowrise-hms/api
Package api
Short Description FlowRise HMS API module — RESTful endpoints and Scribe documentation
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api
Api module
In one sentence: Optional REST API layer for mobile and third-party clients — Sanctum token authentication, Scribe documentation tooling, and the switch that turns on the domain REST endpoints registered by other modules.
Current status
In progress. Token login/logout and Scribe docs generation are implemented. Domain REST endpoints exist for services, patients, staff (+ credentials), drugs, dispenses, appointments and the waitlist; they are registered by Modules\Core\Services\ApiRouteRegistrar only while this module is enabled. Broader CRUD coverage (encounters, invoices, ...) is still to come.
See Module Status for the canonical rollout matrix. Verified against code on 2026-09-20.
What is implemented
POST /api/v1/auth/login— email/password → Sanctum personal access token (throttle:5,1)POST /api/v1/auth/logout— revoke current token (auth:sanctum)GET /api/docs→ redirects to/docs(generated Scribe HTML, auth required)php artisan api:generate-docs— wrapsscribe:generate --force- Domain REST routes (Sanctum +
api.branch) from Core (services), Patient (patients), Staff (staff,staff/{staff}/credentials), Pharmacy (drugs,dispenses), Appointment (appointmentsincl.check-in,cancel,bulk-reschedule;waitlist,waitlist/{id}/offer-slot) — see API Reference - Feature test:
Modules/Api/tests/Feature/ApiAuthTest.php
What is deferred
- REST endpoints for encounters, invoices, inventory and other operational resources
- Scribe coverage of the domain endpoints (the module's
config/scribe.phpis overlaid onconfig('scribe')byApiServiceProvider::register(), so the title,api/v1/*route match and auth settings apply; endpoint annotations are still incomplete)
What happens if this module is disabled
The auth routes and every route registered through ApiRouteRegistrar disappear. Billing (/api/v1/billing/*), Insurance (/api/v1/insurance/*) and FHIR (/api/v1/fhir/*) endpoints remain available from their own modules regardless of this module's status.
For FHIR R4 clinical exchange, use the FHIR module, not this module.
Dependencies
Modules\Core(declared inmodule.json)- Laravel Sanctum (host app;
SANCTUM_STATEFUL_DOMAINS,SANCTUM_TOKEN_PREFIX)
For developers
- Namespace:
Modules\Api\... - Service provider:
Modules\Api\Providers\ApiServiceProvider - Routes:
Modules/Api/routes/api.php(auth),routes/web.php(/api/docsredirect) - Branch scoping:
api.branch=Modules\Core\Http\Middleware\SetCurrentApiBranch(403 when the token owner has no branch) - Docs: API Reference
