baarkerlounger
/
submit-social-housing-lettings-and-sales-data
mirror of https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Submit social housing lettings and sales data (CORE)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3257 Commits
218 Branches
260 Tags
83 MiB
Tree: bef5e84b7a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bef5e84b7a'
${ noResults }
submit-social-housing-letti.../docs/app_api.md

16 lines
1.1 KiB
Raw Normal View History Unescape

CLDC-2608: add documentation for the app api (#2015)
1 year ago
---
nav_order: 8
---
# Using the App API
In order to use the app as an API, you will need to configure requests to the API as so:
Yarn package upgrades (#2590) * Upgrade yarn packages to clear dependabot warnings * Add prettier * Run prettier * Update docs * Update babel config for moved plugins * Add node_modules and similar to prettierignore, since on CI it's not run from same directory as gitignore
4 months ago
- Configure your request with Basic Auth. Set the username to be the same as `API_USER` and password as the `API_KEY` (`API_USER` and `API_KEY` are environment variables that should be set for the application)
- Check the endpoint you are calling is an action that is `create`, `show` or `update`
- Check you are setting the following request headers:
- `Content-Type = application/json`
- `Action = application/json` N.B. If you use `*/*` instead, the request won't be recognised as an API request`
CLDC-2608: add documentation for the app api (#2015)
1 year ago
CLDC-3695 Update docs (#2795) * Update readme * lint * typo * Update app api doc * lint
1 month ago
Currently, only the Logs Controller is configured to accept and authenticate API requests, provided that the specified API environment variables are set. Please note that the API has not been actively maintained for an extended period and may not function as expected. Additionally, the required environment variables are not configured on any of the environments deployed on AWS, rendering API requests to those environments non-functional.