Skip to main content

Part of Integration process overview

Stage 5 - Maintain

Current Chapter

Current chapter – Stage 5 - Maintain


Find out how to develop additional functionality post go-live and how to keep up-to-date with the e-Referral Service API changes.


5.1 Adding new functionality to a live solution

Once you are in production, you can develop further functionality with our API.

If requesting new endpoints for an existing assured solution:

  1. Return to Stage 2: Build, step 2.5 'Request the Supplier Conformance Assessment List (SCAL)'.
  2. Request an up to date SCAL by emailing the e-RS Solutions Assurance team [email protected] and continue through the process.

If you require access to additional endpoints, contact the Information Technology Operations Centre (ITOC) team. Provide details of your Accredited System Identifier and which new endpoints you plan to integrate with.

The ITOC team will be able to grant permissions as needed.


5.2 Adding a new site/customer to a live solution

Contact Live Services Onboarding

To add a new site or customer to your live solution, email the Live Services Onboarding Team [email protected] and include [email protected] for information.

Inform them of who you are, what your product is called, and that a new site/customer will be using your integrated software.

They will require details such as the site/customer:

  • name
  • ODS code
  • contact name
  • contact email

You should also advise them whether the new site/customer:

  • will have the same permissions as your existing live sites
  • is using the application-restricted, unattended access mode
  • has accepted the end user organisation policy

Finally, you will need to check whether your existing connection agreement remains valid, or whether any changes will be required.

Receive live connection details

The Deployment Issue Resolution team will provide details required for your go live, including the ASID.

The partners team will work with you to create and activate your production APIM application, configuring it for your chosen access mode.

Governance

If you have opted to use the application-restricted, unattended access mode, there are additional requirements you must be aware of and adhere to.

It is vital that this section of our documentation is read and understood by both yourself as the partner, as well as your customers or end user organisations.


5.3 Patching and endpoint changes

It is imperative that partners keep up to date with API developments.

Patching

Partners must keep up to date with frameworks and libraries that may be used internally. This also extends to our API and it's functionality.

This may mean a need to be re-assured from time to time, depending on your software changes.

Historical and upcoming changes

You can follow our latest updates and plans for future development in our updates and releases section.

We also communicate all changes to partners ahead of time.

Note that we may require you to change your solution to keep up-to-date with the development of our API. Similarly, documentation like the Supplier Conformance Assessment List is periodically reviewed and updated.

It is a contractual requirement that live partners ensure they are using the latest version of the SCAL. Partners may be asked to re-submit updated versions, even when live.


Contact us

Get support on integrating with our API by checking out our developer community.

You can:

  • search and find answers to your query
  • post your own questions
  • join a community of professionals with similar objectives

Last edited: 26 March 2025 3:57 pm