Display pension funds data in your systems, in real time.
We have created a RESTful API (Application programming interface) so that you can display PFO data in real time, embedded within your own programmes or CMS’s such as Salesforce or Microsoft Dynamics.
How does it work?
Following some development work, your programme will automatically be able to access live data from PFO and display the data in your records.
The data feed provided can be adapted to your individual business needs, whether you want to see financial data, asset allocation, mandates or adviser information - the choice is yours, just let us know.
See example below showing the basic data feed i.e. a record in Salesforce (or an equivalent CRM) for the XYZ Pension Fund with PFO’s XYZ Pension Fund record displaying scheme assets and funding ratio in your record, in real time.
How do I get connected?
1. Appoint a technical developer to work on the project
2. Accept the T&Cs - you can find a link to these at the bottom of this page
3. Provide us with the URL (this is the URL from where the data will be called from, your developer will provide this)
4. Click ‘Request API Key’
5. We will process the URL, generate an API key that will be emailed to you
6. Your developer will use the API Key to connect to PFO data via the API.
7. Authentication process complete and you have access to PFO data.
Any questions?
Here’s a list of FAQs, if you need any further assistance please contact Graham Hatch on 020 7139 1536.
FAQs
1. Is it a RESTful API? Yes, HTTP get request are allowed with limited parameters
2. What is the base URL? http://api.pensionfundsonline.co.uk
3. What are the parameters, headers, authentication method, resource return content-type (e.g. JSON), etc.”? Please see http://api.pensionfundsonline.co.uk/api-docs
4. Where shall I send the request URL? Please send it to http://api.pensionfundsonline.co.uk/api/PFOEntry/{datasetid}/{currency [available options: gbp, eur, usd]}
5. Do I need to generate different keys for QA and Production environments? You would only need a new key for all unique domains
6. What response codes should be for a request? 200 Successful calls, 401 unauthorized, 500 server errors.
7. How do I get your key and default domain? By requesting one from us
8. Do I need the full URL including the folder? no, just the domain name. Please include the scheme i.e. HTTP:// or HTTPS://
9. Do I need to send a header API_KEY with the key as a value? Yes, you need to make sure the call is coming from the domain you setup for the token as it using the origin as part of the authentication process. The plan is to migrate to using Authentications and Bearer tokens in the future.
10. How do we transmit our API key for authorisation? Via header: API_KEY
11. Does the API key need to be encoded in any way? At present no encoding is required
Example using Request
http:Request:
HttpRequest req = new HttpRequest();
req.setEndpoint('http://api.pensionfundsonline.co.uk/api/PFOEntry/{datasetid}/{currency}');
req.setMethod('GET');
req.setHeader('content-type', 'application/json');
req.setHeader('API_KEY', 'YOUR API KEY');
req.setHeader('Origin', ' https://your.url.com’);
Http http = new Http();
HttpResponse res = http.send(req);
