forms-submission-api

API to track form submissions. Currently tracks file submissions only.

See docs/ for documentation.

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
  • Production
  • Npm scripts
• API endpoints
• Docker
  • Development Image
  • Production Image
• Licence
  • About the licence

Requirements

Node.js

Please install the Node.js version in .nvmrc using Node Version Manager nvm via:

cd forms-submission-api
nvm use

Local development

Setup

1. Install Docker

2. Bring up runtime dependencies

docker compose up

3. Create a .env file with the following mandatory environment variables populated at root level:

MONGO_URI=""
MONGO_DATABASE=""
OIDC_JWKS_URI=""
OIDC_VERIFY_AUD=""
OIDC_VERIFY_ISS=""
ROLE_EDITOR_GROUP_ID=""
HTTP_PROXY=
HTTPS_PROXY=
NO_PROXY=

For proxy options, see https://www.npmjs.com/package/proxy-from-env which is used by https://github.com/TooTallNate/proxy-agents/tree/main/packages/proxy-agent. It's currently supports Hapi Wreck only, e.g. in the JWKS lookup.

Development

To run the application in development mode run:

npm run dev

Production

To mimic the application running in production mode locally run:

npm start

Npm scripts

All available Npm scripts can be seen in package.json To view them in your command line run:

npm run

API endpoints

Endpoint	Description
GET: /health	Health
POST: /file	Ingests a file with a 7 day expiry. Called by the CDP uploader as a callback (upon file upload)
GET: /file/{fileId}	Checks that a file has been ingested.
POST: /file/link	Creates a link to a file which can be accessed by a user. Valid for 60 minutes.
POST: /files/persist	Extends the expiry to 30 days. Called upon form submission.

Docker

Development image

Build:

docker build --target development --no-cache --tag forms-submission-api:development .

Run:

docker run -e GITHUB_API_TOKEN -p 3008:3008 forms-submission-api:development

Production image

Build:

docker build --no-cache --tag forms-submission-api .

Run:

docker run -e GITHUB_API_TOKEN -p 3001:3001 forms-submission-api

Licence

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the licence

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.