Getting Started

Welcome to the RPACS documentation. This site describes the platform's capabilities and the HTTP endpoints available to integrations.

Explore the Platform

Start with the feature catalog for an overview of exam management, reporting, organization administration, integrations, and access controls supported by the current application.

API Documentation

When API documentation is enabled on an RPACS installation, two endpoints are available:

• /api-docs provides an interactive Swagger interface.
• /api-docs.json provides the OpenAPI document for tools and integrations.

Set DOCS_ENABLED=true in the application environment to expose these endpoints. The documentation uses the application's configured ROOT_URL as its server address when available.

Access and security

Only enable API documentation in environments where it is appropriate to expose the endpoint inventory. Authentication and authorization requirements still apply to the underlying API operations.

Search These Docs

Use the search field in the navigation bar to search the documentation locally. Search runs in the browser and does not require an Algolia account.

Need Help?

Visit rpacs.com.br to learn more about RPACS and find the available support channels.