This page provides resources for users at all levels to learn how to use the Data Integration Platform (DIP) effectively.

User roles and tasks

Learn about the different roles needed to perform key tasks.

DIP user guide

Guidance for all market participants on how to use the Date Integration Platform, along with role-specific instructions. The document includes information on: User Roles and Permissions; DIP User Admin; DIP users Certificate Admin; DIP Users Message Admin; DIP Users Analytics Reader; some FAQs; and Support and Contact Information.

DIP Portal user guide (Size: 2.90 MB)

Onboarding

Step-by-step instructions for all users who need to get access to the Data Integration Platform.

Open API definition

An Open API (or “Swagger”) specification, called “SubmitEvents”, is used to describe and document the REST-compliant endpoints to send and manage data between participants using the DIP. The specification defines the API endpoint that DIP Users use to send arrays of interface messages to the DIP and receive interface messages from the DIP to webhooks that are registered via another HTTP POST endpoint.

Additionally, the DIP SubmitEvents API specification defines endpoints to replay or requeue interface messages, and to send and register webhooks for status messages. For each endpoint, the DIP SubmitEvents API specification defines the URL parameters (including header information), and the request body structure.

The latest published version of the DIP SubmitEvents API specification is hosted at https://app.swaggerhub.com/apis/MHHSPROGRAMME/SubmitEvents/

Further information

Offboarding

Steps to take if you no longer need access to the DIP.