Getting Started with Dynamic API
Last updated
Last updated
First, create your account in the Aurinko portal, then follow the guide to get your developer API keys. When presented with the New Application dialog choose the CRM feature.
Next, navigate to Settings and specify your app's OAuth details (clientId+secret) for your Salesforce and Hubspot integrations.
Now, navigate to Accounts to test creating Salesforce and/or Hubspot accounts.
Once a new account is added you can find its Aurinko access token on the Account page. You will need this token to make API calls later.
Upon adding a CRM account, its metadata is automatically loaded into the system. You will be able to examine the provider metadata under Virtial API / Provider Models
The Virtual APIs tab displayes your virtual data models. You'll find a pre-built virtual model named AurinkoContacts. This model serves as a foundational template, representing common mappings for CRM objects like Contacts and Companies.
Creating a Model Mapping
To establish a connection between your virtual model and the specific CRM data, create a Model Mapping (also referred to as a mapping configuration or configuration).
This configuration defines how the objects and fields in your virtual model will be translated to and from the provider objects and fields within your chosen CRM system.
Use a specific CRM account to create a mapping as this will allow you to map all custom CRM objects and fields of the specific CRM instance.
Once a new mapping (configuration) is created select it on the right hand side and you will be able to start mapping objects.
Creating an object mapping will take you to the object page name for the current model configuration (SFDC mapping in our case)
Once you're done mapping objects and fields of one configuration (i.e. our SFDC mapping) you can create your next configuration, i.e. Hubspot and establish those mappings.
You can have as many mapping configurations as you need. Many Salesforce and Hubspot instances have their own customizations so you may need a CRM configuration per customer. Create them in Aurinko once needed and remember their ids. You will be able to reference a specific configuration when calling the /dynamic API. Creating all common object mappings manually maybe quite tedious so reach out to our support team for help. We should be able to share common pre-built mappings which you'll be able to import into your app.
Aurinko Dynamic API offers a unified API experience, but with the key advantage of being virtualized. This means the API endpoints are dynamically generated based on your configuration. Here's an overview of the endpoint structure:
Metadata Endpoints:
/dynamic/{configId}/metadata/{objName}: Retrieves metadata for a specific CRM object (e.g., contacts).
/dynamic/{configId}/metadata/{objName}/{fieldName}: Retrieves metadata for a particular field within a CRM object.
Object Endpoints:
/dynamic/{configId}/objects/{objName}: Retrieves a list of objects of a specific type (e.g., all contacts).
/dynamic/{configId}/objects/{objName}/{id}: Retrieves a single CRM object by its ID.
/dynamic/{configId}/objects/{objName}/{id}/{childRelationship}: Retrieves data related to a child relationship of a specific CRM object.
Click 'Map' button for objects that have not been mapped yet.
You can start mapping fields by clicking the 'Map' buttons. Established mappings show 'Connect' icon:
