Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.01 KB

README.md

File metadata and controls

54 lines (39 loc) · 2.01 KB
Raw

smart_cart_api_server

API for smart carts

Setting Up

Ensure you have poetry set up. Once that is set up clone this project.

Running The Smart-Cart API Server

To run the API server simply run:

RMF_SCAS_CARD_ID_CSV=<path-to-card-id-csv> smart_cart_api_server

API Docs should be available here at http://127.0.0.1:9090/docs.

You will need RMF's api_server and RMF running in the background. The api server endpoint can be set via args or the API_SERVER_URL environment variable.

Dev Server

A dev server with auto reload can be started with

RMF_SCAS_CARD_ID_CSV='CardId.csv' poetry run uvicorn smart_cart_api_server.endpoints.endpoints:app --reload --port 9090

Authenticating Cards via API server

By default we provide a simple csv based authentication mechanism. You need to have a csv file called CardId.csvin order to be able to use it.

"cardid", "aactive_directory_id", "clinic", "location2", "location3"...

Note: If there is a change in the file, you will have to restart the server as the file is read only once. The server is stateless so this should not be much of a problem. An example CardId.csv is provided. If you want to change card authentication providers, then please extend the smart_cart_api_server.models.tables.CardIdADIDTable.AbstractCardIdADIDTable class and update endpoints.py.

Integrating with keycloak and card readers

Add a keycloak_config.json to your working directory and set export ENABLE_KEYCLOAK=1. The config should look like this:

{
    "server_url": "http://localhost:8080/",
    "realm": "master",
}

Note: we do need the admin api in order to perform some of the verification.

Mock server

If you need a mock server for development purposes (without running RMF) then you can run the following.

poetry run uvicorn smart_cart_api_server.tools.mock_server:app --reload --port 9090

API Docs should be available here at http:127.0.0.1:9090/docs.