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.
2863 Commits
233 Branches
250 Tags
74 MiB
 
 
 
 
Tree: 845065d2d3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '845065d2d3'
${ noResults }
submit-social-housing-letti.../docs/app_api.md

778 B
Raw Blame History

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:

  • 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`

Currently only the logs controller is configured to accept and authenticate API requests, when the above API environment variables are set.