You can publish a Hosted API to a workspace by following these steps:
- Select the My workspace link from the navigation menu or the task link option within the body of the homepage. This will take workspace listing page.
- Select the API name link from the API section of the workspace Overview page. This will show you the API details page.
- Select the Overview menu option for the API. This will show you the Publish sub-menu option.
- Select the Publish option. This will show you the Publish API page to perform a validation of information entered.
- Review the list of changes you are about to make by viewing the change list comparing the existing and new configurations covering the different section and environments within the Compare changes section.
- Review and confirm any Personal Information (PI) exposure to users from using your API. This is to comply with data protection legislation including the standards outlined in the links to Personal data and The Department for Education (DfE) data protection hub provided on the page.
- Select Publish API to confirm and publish the Hosted API ready use. Or Return to API overview link to cancel.
You can read the Guidance on API standards which tells you the standards expected for any API to be added to the DfE Catalogue.
If you select the option declaring that your API may expose Personal Information (PI), then you must select the checkbox to confirm that you have read and understood the standards outlined in both the Personal data and The Department for Education (DfE) data protection hub before you will ba allowed to publish your API. Once you publish your API, the Status entry within the API's detail page will appear as 'Publishing'