RealMe for Developers and Integration Teams
RealMe.

How to integrate

Your integration project

Over 150 online services have integrated with the RealMe® login service and over 170 with the RealMe assertion service. The RealMe integration team are therefore very familiar with what's required to get to production and go live.

Your integration project will be coordinated by the RealMe integrations team. The team will assist you to schedule and coordinate integration timeline activities, arrange integration technical advice, and confirm go live criteria. Overall, it's your agency's project plan that sets the pace and milestones.

The integration project is managed via our online integration portal(external link), accessed via the RealMe Developer’s website.

The integration team will also advise and review the business process design for the online service. The RealMe design and branding guide provides all the RealMe elements that need to be added to an agency's webpages, and describes how the login service or assertion service pages can be co-branded with agency images and instructions to deliver a good user experience.

A project moves through three environments to implement an online service integration:

  • Messaging Test Site (MTS) is a good first step for testing your SAML or OIDC component works as expected

  • Integration Testing Environment (ITE). All projects involve at least one pre-production ITE integration. For large, strategic projects it's possible to connect multiple environments to ITE such as system development, performance testing and user acceptance testing.

  • Production This is either a technical production release to allow for security and penetration testing before formal go-live, or a full production release at go live.

The core steps for technical integration (SAML and OIDC) describes what is involved in configuring and connecting the agency's online service to the RealMe ITE and Production environments.

The go-live checklist provides a summary of the activities that you'll need to complete for the project.

For online application providers including cloud applications that are not yet actively working with a government agency, RealMe also supports vendor technical integrations. If your company has successfully integrated with MTS, then complete the vendor access application, and we can set up a connection to the ITE environment so this can be used for demonstration purposes. For other integration related queries, contact RealMe with a general enquiry or email integrations@realme.govt.nz