Is there a UAT or Sandbox environment for the Mercury API for testing?
Currently there is no UAT or Sandbox API environment available for testing.
What authentication methods does the API support?
We only support basic authentication using security API tokens.
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 Products database is not available via the Public API. You can only integrate with Person and Opportunity records.
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).
Can I add NotePad text when creating a new record?
Yes. You can send text to the NotePad of a Person or Opportunity record when generating a new record using the following field in the payload.
"notePadText": "add your text here"
Can I add Notes on Person and Opportunity records via API?
No. You can however retrieve the Person or Opportunity mercury inbox email address and emails can be sent to that email address. The mercury inbox email address is listed on records as the following.
"emailAccountAddress"
Can I add Person Categories via API?
Yes. Each of your Person Categories will have a unique ID in the database itself. The unique IDs will be visible in the browser developer tools network section as they are added to a record. Once you have the unique ID for each separate Person Category they can see included in payloads to the Person record categories subsection.
"categories": []
Is there a front end I can use to view the opportunities and contacts created via API?
Yes. To view the records, you can login to Nexus via the standard login page. https://login.connective.com.au/
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 [email protected]
Is there a Client SDK I can download to get started with the API straight away?
Yes. Download the swagger latest definition from Swagger File 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 link contacts with opportunities via the API?
To link Contact records with Opportunity records, use one of the below methods.
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:
{ "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
{ "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 and phone numbers when creating a new contact via API?
You need to pass a nested contactMethod object to set the email when creating a new contact.
Example payload can be found here.
I want to integrate the Nexus CRM with a third party database application - where do I start?
If the third party has dedicated support you would first liaise with them. Typically other databases which have the capability to integrate will have some set steps to get up and running and it might be as simple as inputting your API Key and Token into their interface.