flowrise-hms/api

FlowRise HMS API module — RESTful endpoints and Scribe documentation

Maintainers

Package info

github.com/Flowrise-HMS/API

Type:laravel-module

pkg:composer/flowrise-hms/api

Transparency log

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

dev-main 2026-07-20 01:47 UTC

Requires

MIT e89fe9da72ba70d5ae329926bb74ad11fcda8a5b

Published on Packagist.org on 2026-08-02 12:18 UTC

This package is auto-updated.

Last update: 2026-08-02 12:19:57 UTC

README

In one sentence: Optional REST API scaffolding for mobile and third-party clients — Sanctum token authentication plus Scribe documentation tooling.

Current status

Production-ready. Token login/logout, Scribe docs generation, and domain REST resource endpoints are all implemented and gated behind this module. Disabling the Api module removes all resource endpoints.

What is implemented

  • POST /api/v1/auth/login — email/password → Sanctum personal access token
  • POST /api/v1/auth/logout — revoke current token (auth:sanctum)
  • Scribe v5 auto-generated API documentation at /docs
  • Read-only resource index/show endpoints for: Patients, Drugs, Dispensing, Services, Appointments, Waitlist
  • Feature test: Modules/Api/tests/Feature/ApiAuthTest.php

What happens if this module is disabled

All routes registered through ApiRouteRegistrar (all domain REST resources) are removed. Billing webhooks, Insurance sync, and FHIR endpoints are always available regardless of this module's status.

For FHIR R4 clinical exchange, use the FHIR module (/api/v1/fhir/*), not this module.

Dependencies

  • Modules\Core (declared in module.json)
  • Laravel Sanctum (host app)

For developers

  • Namespace: Modules\Api\...
  • Service provider: Modules\Api\Providers\ApiServiceProvider
  • Routes: Modules/Api/routes/api.php
  • Docs: API Reference