Steps to ingest data files

Difference between State Specific programs and National programs API

State Specific Programs API

National Programs API

  1. Accepts file in .csv format

  1. Accepts file in .zip format

  1. It is mainly used when the state team wants to onboard new programs apart from the starter pack.

2. This API can be used for starter pack programs of VSK and NVSK

  1. The uploaded file will be present in the process_input folder in cloud storage given that there are no errors in the data.

3. The uploaded file will be present in the emission folder in cloud storage given if there are no errors in the data

Note:

The ingestion API’s have prerequisites to work. Whenever any file is uploaded it should have the specified schema stored in the DB. This can be done by making use of spec API’s.

Generate JWT token API

Step 1:

Create a postman request & add details.

API Endpoint: <domain_name>/api/ingestion/generatejwt

HTTP Method: GET

Step 2:

Click on the send button for request and if the request is successful the user should see a jwt token generated. Please refer to the below screenshot.

Note:

The token generated using the above API is passed in Authorization headers in all the ingestion API’s. If the token is not passed then the API will not work. To pass the token in postman go to the Authorization tab in postman and select the bearer token option from the drop down present on the left menu. On the right side paste the jwt token generated through API. Please refer to the below screenshot.

Last updated