We provide a REST-ful HTTPS API for automated interfaces between your systems and our service. Our API uses predictable, resource-oriented URI's to make methods available and HTTP response codes to indicate errors. These built-in HTTP features, like HTTP authentication and HTTP verbs are part of the standards underpinning the modern web and are able to be understood by off-the-shelf HTTP clients.
Our API methods return machine readable responses in XML format, including error conditions.
If your Rapptr installation is available at https://%company%.fundapps.co/ the URI from which your API is available is https://%company%-api.fundapps.co/. Ditto, staging api is available at https://%company%-staging-api.fundapps.co/ All requests made to our API must be over HTTPS.
You authenticate to the Rapptr API via Basic Authentication over HTTPS. A Rapptr administrator from your organisation must create a user with the role "API" for this purpose. You must authenticate for all requests. Note: Please ensure you create a seperate user for the API as if you use an existing user's account, as soon as they change their password the API upload will fail.
A number of methods are available, depending on the kind of data being uploaded. Typically customers send us a position file once or more a day; other uploads are optional and depend on business requirements.
All of our API methods expect your upload file to be sent as the body of the request; our example implementations show how to achieve this with commonly used HTTP libraries.
Upload Daily Positions. This method expects to receive data in XML format (example XML position files); large files may be zipped. The response includes a link which when polled allows monitoring of the progress of processing the file.
(Request Headers)
POST https://%company%-api.fundapps.co/v1/expost/check HTTP/1.1 Content-Type: "application/xml"
(Response)
<links>
<result>/v1/ExPost/Result/fe633307-f196-4609-abfe-a1fc0111e875</result>
</links>
We make an XSD schema available for the position upload XML format; this may be retrieved from the GET /v1/expost/xsd API endpoint on your Rapptr instance . If you don't have access to an instance yet and would like access to an XSD file, please contact support.
Check the progress of the rule processing on a position upload. As noted above, when uploading a position file the specific URI for checking progress is provided; the unique ID of the job is included in the URI.
This endpoint returns a 202 Accepted HTTP status whilst the check is in progress and a 200 OK status when the check is complete. The progress of validation and rule execution is reported separately in the response.
| ValidationState | RuleState | Explanation |
|---|---|---|
| Unknown | Unknown | Job just received; not processed yet. |
| Pending | Pending | Job queued |
| InProgress | Pending | Validation in progress |
| Passed | InProgress | Rule execution in progress |
| Failed | NotRun | Validation failed; rule processing canceled. |
| Passed | Failed | Rule execution failed. |
| Passed | Passed | Rule execution successful. |
When the rule execution is completed successfully, an additional 'Summary' element is provided in the response. This aims to provide the same information as the email notification sent by Rapptr when a positions file finishes processing.
The Summary element is comprised of:
- The total number of alerts by type - i.e. Breach, Unknown, etc.
- The number of new alerts by type (since the day before).
(Request)
GET https://%company%-api.fundapps.co/v1/ExPost/Result/fe633307-f196-4609-abfe-a1fc0111e875 HTTP/1.1
Content-Type: application/xml
(Response Headers, Rules running)
HTTP/1.1 202 Accepted
Content-Type: application/xml
(Response Content, Rules running)
<?xml version="1.0" encoding="utf-8"?>
<ResultsSnapshot ValidationState="Passed" RuleState="InProgress" />
(Response Headers, Validation failed)
HTTP/1.1 200 OK
Content-Type: application/xml
(Response Content, Validation failed)
<?xml version="1.0" encoding="utf-8"?>
<ResultSnapshot ValidationState="Failed" RuleState="NotRun" />
(Response Content, File processed successfully)
<?xml version="1.0" encoding="utf-8"?>
<ResultsSnapshot ValidationState="Passed" RuleState="Passed" Status="Okay" PipelineStage="Finished" Duration="00:01:28.7030000">
<Summary DataDate="2015-07-20">
<Breach Total="1" New="1" />
<Disclosure Total="18" New="18" />
<Unknown Total="2" New="2" />
<Warning Total="4" New="4" />
<OK Total="399" New="399" />
</Summary>
</ResultsSnapshot>
Upload Index data, if you wish to decouple this from your daily position upload. Expects CSV - example file.
Upload Portfolio data, if your portfolio structure changes frequently you may wish to refresh this at an appropriate frequency. Expects CSV - example file.
Upload Transaction data. Expects CSV - example file.
When sending data to the API we expect certain content types to be set on your request e.g.
POST https://%company%-api.fundapps.co/v1/expost/check HTTP/1.1 Content-Type: "application/xml"
These Content-Type values are as follows:
| Input Type | Content-Type |
|---|---|
| CSV | text/csv |
| XLS | application/vnd.ms-excel |
| XLSX | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| XML | application/xml |
| ZIP | application/zip |
When uploading data to the API, it is stored and later displayed in Rapptr using a default file name. To specify a different file name, populate the "X-ContentName" header, e.g.
POST https://%company%-api.fundapps.co/v1/expost/check HTTP/1.1 Content-Type: "application/xml" X-ContentName: "positions-monday.xml"
| Type | Definition | Example |
|---|---|---|
| Boolean | Must be the word true or false | true |
| Date | Must be in "YYYY-MM-DD" format (ISO 8601) | 2015-12-31 |
| Decimal | Must use "." as decimal separator. Group (thousand) separators are not allowed, exponential formatting not allowed. Up to 21 decimal places are supported. | 123444.227566 |
| Integer | Whole number (positive or negative). Group (thousand) separators are not allowed, exponential formatting not allowed | 19944 |
| String | A sequence of characters. When using CSV format must not include commas (","). | Nokia |
| List | Comma separated string | XNYC,XLON |
We provide a number of example implementations against our API using commonly available programming languages and libraries in this repository.