How do I request access to the UAT API?
Please log a ticket with the connective helpdesk at helpdesk@connective.com.au requesting access to run API queries in UAT.
The Helpdesk will request that your group is activated in the UAT environment. Production API access is available using details found in Admin tab >> Integrations.
An API key: this will uniquely identify your broker group
An API user security token: This will be a security token with a long expiry date, linked to a mercury user account set up specifically for API access
Can I request additional long live tokens?
Yes. Depending on the kind of integration you are building, you may need additional security tokens for API access. You can request additional tokens by raising a request with connective helpdesk at helpdesk@connective.com.au
What authentication methods does the API support?
As of now we only support basic authentication using security tokens. However, we are working towards introducing Oauth2 in the future.
Can I use API with a Virtual Branch?
Yes. The API Key is the same for all branches at the group but each branch has it's own unique API Token. To find out the branch token you must login as a Mercury account which is a member of that branch which also has Partner Level access.
What if the field I want to use does not have an endpoint?
Not all Person and Opportunity fields currently have endpoints. If you want a new field made available, request this via the Ideas Portal. When updates are made these requests will all be taken into consideration.
Is the Connective Products data available via API?
No. Currently the Connective Public API only integrates with Person and Opportunity records.
Is there a development or UAT environment which I can use to build and test my integration?
Yes. When you request access to the API, you will be provided access credentials to the UAT environment. For more details, please refer to the API Environments page.
How do I switch over my integration from UAT to production once I am happy with my testing?
Once you are satisfied with the testing on the UAT, contact us to enable API access to Production. You then just need to switch over from the UAT URL to the production URL to make your integration live
For details about the Production URL please refer to the API Environments page.
How do I upload documents using the API
You can upload documents against an opportunity by emailing to the opportunity's mercury inbox email Id (CURRENTLY UNAVAILABLE).
Is there a front end I can use to view the opportunities and contacts created in the UAT?
Yes. https://loginuat.connective.com.au
Raise a ticket with the Mercury helpdesk to issue credentials for UAT.
Is the API free? Are there any limits to how many requests I can make
Yes. The current version for the API is free for the connective members.
There are limits to the number of API calls that can be made:
The max requests per second is limited to 60
The daily quota of requests is limited to 40000 requests
Note: If you have specific needs for which you need additional request quota, please contact us via the standard help desk process.
Is there a Client SDK I can download to get started with the API straight away?
Yes. Download the swagger latest definition from Swagger 2.0#DownloadtheMercuryAPISwaggerspecification and then copy-paste it into the Swagger Editor. Use the Generate Client button on the Swagger Editor to download the client SDK in a language of your choice. Swagger Editor provides SDK generation for about 38 different languages.
How do I receive the latest updates about the changes being made to the API?
When you request access to the API, we'll add you to the API users mailing list and will keep you informed of any enhancements, features being made to the API.
How do I link contacts with opportunities via the API?
There are 2 ways you can achieve this.
-
If you already have a contact created in mercury and want to link it with a new opportunity then, do a POST to the opportunity endpoint and in the body make sure you have the related parties nested object and the "personId" contains the unique id of the Contact you want to link:
URL: https://uatapis.connective.com.au/mercury-v1/{token}/opportunities
{
"opportunityName": "My Opportunity",
"amount": 0,
"lender": "NAB",
"lenderNameShort": "NAB",
"status": "Pre Approval",
"agent": "CA54205",
"personActing": "CA54207",
"personResponsible": "CA54206",
"relatedParties": [
{
"personID": "711e7da5-38c1-4884-9319-1e470e40d6fc",
"relationship": "Adviser"
}
]
} -
If you already have an Opportunity and want to link an existing contact to it then, do a POST to the related parties endpoint, where the "personId" contains the unique id of the Contact you want to link
URL: https://uatapis.connective.com.au/mercury-v1/{token}/opportunities/{id}/relatedParties
{
"personID":"692cc6aa-14e2-11e7-a0a2-00155d009933",
"relationship":"Primary applicant"
}
How do I create a Company contact record?
In the Contact Post payload use the following string instead of a null value.
"contactType": "company",
How do I set the email when creating a new contact via API?
URL: https://uatapis.connective.com.au/mercury-v1/{token}/contacts
{
"firstName": "John",
"lastName": "Doe",
"middleName": "M",
"salutation": "John",
"contactMethods": [
{
"contactMethod":"Email 1",
"content":"abc@abc.com.au"
}
]
}
Comments
0 comments
Article is closed for comments.