Getting Started

Authenticating & Configurating the Adapptr Service

📘

With minimum data points, positions will be sent in CSV format to Adapptr, where Adapptr enriches the file with market data from your chosen data provider, generates a complete XML file and transmits it to FundApps.

Authentication

Authentication to the Adapptr API is done via Basic Authentication over HTTPS. An 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 separate 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.

Your base URL for Adapptr is https://%company%-svc.fundapps.co/api/adapptr,

e.g. https://abc-svc.fundapps.co/api/adapptr

Creating an API User

Setting up a user with the API user role in your FundApps environment is the first step to authenticating with our services. You can follow instructions here on how to set up an API user if this has not been done already.

On creation, an email will be sent to the email address given for the API user. The email address provided must be a real email address and have an accessible inbox - we recommend using a support

🚧

API users are not able to log in to the UI - please do not use the email address of a UI user.

❗Note: If the password for an API user is changed and this update is not captured in authentication method, it may lead to error 401 for unauthorised user.


Configuration

Available Nomenclatures GET /v2/nomenclatures

List of available data providers, identifier types, position services and more. Those can be requested from this endpoint. You must then use the appropriate ids for parameters in other requests.

IdData Provider
1Refinitiv
2Bloomberg
IdIdentifier Type
1Isin
2Sedol
3Cusip
4DataProviderId
IdPositions Service
2Shareholding Disclosure
4Position Limits
6Shareholding Disclosure & Position Limits
IdFile Data Formats
1FundApps
2Consensys

Data Provider Credentials

POST /v2/configuration/dataproviders/:providerId/credentials

Refinitiv
If you are using Refinitiv data you must submit your username and password to this endpoint. Before being able to post a file to Adapptr, your data provider credentials must be set. Your file upload will otherwise fail because FundApps will be unable to connect and authenticate against the data provider.

Bloomberg
This endpoint does not support Bloomberg data provider. The support team will use your Bloomberg generated certificate to enable Adapptr integration. Please contact [email protected] or your Implementation Manager for more details.

e.g.
{ "Username": "[Username]", "Password": "[Password]" }


What’s Next