Last updated
Was this helpful?
Last updated
Was this helpful?
This page provides comprehensive documentation for the installation of SPAR Self Service API, a service designed for data mapping within the Social Payments Account and Registry (SPAR) system.
Any machine running Linux (e.g., Ubuntu), macOS, or Windows
Python3.10 or later
Git
PostgreSQL
virtualenv
eSignet: Ensure that eSignet is properly configured. Refer to the for setup instructions.
SPAR Mapper API Configuration: Ensure that the SPAR Mapper API is properly configured according to the .
The following dependencies are managed in the installation steps below.
Install dependencies
Clone the repository.
Navigate to the project root.
Create a virtual environment with Python 3.
Activate the virtual environment.
Install the necessary dependencies.
Create a '.env' file and configure database credentials
Set the following environment variables to configure the spar-mapper-api.
Database setup (skip this step if database is already setup)
Run migrations to set up the database.
This will seed the database with default values.
To integrate the SPAR Self-Service UI with any login provider, you need to add the redirect_uri
in the authorization_parameter column.
This URL needs to be updated in the login_providers
table, specifically in the authorization_parameters
column for the eSignet record.
Make sure to replace selfservice.qa.openg2p.net
with the appropriate domain that matches your eSignet configuration.
Start the development server.
Access Swagger API Documentation.
Run the unit tests with pytest.
The spar-self-service-api
supports authentication via eSignet. Refer to the deployment documentation for eSignet for setup instructions.
Contribution guidelines are available .