This document defines the server-side API required to enable communication with Signatus Mobile App through the “REST channel” feature of the SIGNATUS mobile application.
1.1 Authentication #
Every API operation must be protected to prevent unauthorized access. The Signatus Mobile Apps supports two types of authentication:
Basic Authentication #
For stateless access, the Signatus Mobile App supports Basic Authentication. In this case, Signatus include the Authorizationheader in every HTTP request.
Session-Based (Cookie) Authentication #
This method is intended for stateful interactions. To begin a session, Signatus Mobile App call the /api/login endpoint. Upon successful authentication, the server sets a JSESSIONIDcookie, which Signatus will be include in all subsequent requests to maintain the session.
1.2 Configuration #
The REST API endpoints (URLs) can be configured in the application settings.
1.3 Integration Resources & API Documentation #
To facilitate a smooth and rapid integration process, we have prepared comprehensive API documentation and testing resources. These assets will help your development team understand endpoints, request/response structures, and authentication mechanisms with minimal friction.
Swagger Documentation #
We use Swagger (OpenAPI Specification) to describe and visualize integration API. The interactive Swagger UI allows you to explore all available endpoints, view detailed schema definitions for requests and responses, and perform live API test calls directly from your browser.
You can download the raw OpenAPI definition file below.
Postman Collection & Environment #
For rapid prototyping and manual testing, we have provided a pre-configured Postman Collection. This collection includes:
- Pre-configured requests for all API endpoints.
- Example request payloads and header configurations.
- A pre-defined Postman Environment template to easily switch between your Staging and Production variables (e.g., base URL, username and password).
You can download the Postman Collection and Enviroment file below.