Getting Started with our APIs

Learn about what APIs we offer and how to connect to them.

Contents

1. Overview

If you are developing software and need to integrate with our APIs, this guide is for you.​

Whether you're a product owner, delivery lead, architect, software developer or a business analyst, you'll have a part to play in this process.

2. Learn about our APIs​

Before designing your software, you should:​

  • Get a general understanding of system integration and APIs. ​

  • Explore key concepts and workflows relevant to your domain. ​

  • Review the available APIs and their capabilities. ​

  • Understand how authentication and authorization work. ​

  • Try out example scenarios using ‘Try It’ now button and sandbox environments

3. Connect to API

Connect to APIs using the details provided by HS2.

4. Test Your Software

Work with HS2 to test your software.

5. Software Go Live

Once you’ve completed software onboarding, you’re ready to go live.