Getting Started with Dynamic API

Aurinko account setup

---

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 displays your virtual data models. If you have not created any models yet, start by clicking 'New virtual model'.

You can quickly create a new model from an existing template with a number of CRM provider mappings, i.e. Hubspot, Salesforce, MS Dynamics:

Our AurinkoCRM template will clone a model with three objects: Company, Contact, Deal

and the following mappings/configurations will be pre-populated:

Choose one of them to see how your virtual model is mapped to a provider model, like Hubspot:

Click any object to see its field mappings:

Note the 'Configuration Id', you need to reference this id when using the Dynamic API.

Here is the same Contact object mapped to the Salesforce Contact object (configuration id: 403):

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. Understanding Dynamic API Endpoints

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.