1. Pre requisites - PersonCentredSoftware/RelativesGateway GitHub Wiki

Following must be present before you can begin the implementation

• A website which will host the components.
• CP must have the Relatives Gateway feature purchased and enabled. PCS will issue the CP with these items: a short provider name (e.g. xyz) which can be used to access the PCS-hosted RG website, for example https://www.relativesgateway.co.uk/xyz, and a provider ID which is required for RG API authentication
• CP should create a training Service User, and assign to them a relative who should have a valid email address. This email address will be used by the developer to log into RG and verify that the application is working as expected.

Whitelist

Please note that you must notify PCS of the URL of your 3rd party website from which the RG API requests will be coming. The website will then be added to our whitelist. Without this all API requests will fail.

You can do this by asking the Care Home to raise a support request, asking us to add the specified domain to Relatives Gateway whitelist.

Files

To run the API you will need to get a copy of the pcs-components.js and have JQuery available on your website via the usual $ variable. The current version of API is tested with **JQuery **version 2.2.3, and it will most likely work with other versions which implement Promises. We provide a copy of this library with our code for your convenience.

Please also include the pcs-components.css file into your website which contains basic styling for the charts, images and components layout.

The Forgotten Password functionality of the Login component is currently using JQuery-UI library for the modal window - and our component is tested with jquery-ui-1.11.4.min.js which is included with the code.