Skip to content

Federation Services

Phillip Ferland edited this page Jun 7, 2016 · 1 revision

This is bound to change, right now it is for documentation purposes.

Registration Process

The two sides need to mutually agree to service each others data.

Each admin should exchange their configuration data:

One admin should agree to run the FedServiceInstanceRunFirst.php script. This will generate a local key for this admins instance by inputting the remote instances URL and version and will output it to the console after inserting the data into the federation_servers table. They will take this key and send it to the other instance admin.

This admin will then run the FedServiceInstanceRunSecond.php script. It will ask them for the key that the first admin generated so that it can generate its own key, insert the key and the data of the Remote URL and version. It will then try and connect to the remote instances federation registration URL to add itself to the remote instances server list.

With these steps completed the federation key registration process is done and the admins should be able to test the data query either via the API or the /opt/federation.php page.

Authentication process.

There is two keys that will be used. One for the Data Provider and one for the Service Provider. However, both can be a Data Provider and a Service Provider. There is not hard set side that one has to be, each can connect to the other and query for data with its own key.

Federation API Methods