Overview

Unlock the full potential of Aline CRM with our robust REST API, designed to streamline your workflow by seamlessly integrating content submission and information retrieval. This powerful tool not only facilitates the direct submission of content into the Aline CRM database but also empowers you to effortlessly retrieve valuable information.

Getting Started

There are a couple of things you will need to do in order to start consuming the API. Please note that if you are using a third-party vendor they will need to establish 1) an Integration Agreement to become and integrating partner to allow access to API keys, and 2) will need Third-Party Agreement's to grant them access to each client database. For the agreements we will need the following information for the client company and for the third-party vendor:

• Company Name
• Company Address
• Signatory Name
• Signatory Email
• Signatory Title
• API access Type / reason

Please reach out to your web administrator/agency and provide the Developer Portal Link so they can get a developer account created and request API access.

Please review the following links for creating a developer account and getting subscribed to the API.

• Subscribe to 2.0 API - Recommended for webforms and adding leads
• Subscribe to 3.0 API - Recommended for extracting data which may require an additional review for approval
• API Documentation

NOTE - If the client prefers an API user specific to their environment and naming, then the client can create a developer account and request the API keys and then share with the vendor.  Vendor is still required to be an integrating partner to handle API keys. 

Otherwise vendor issued keys can be re-used to work with additional client partners.  TPA is required per partner.

Once you have created the Developer account and subscribed to an API, please send an email to integrations.support@alineops.com to alert us. Make sure to include the client company name, subscribers name, and email.

Also please review our Webform Best Practices Help Center Article to ensure the webform is best suited for success in the CRM. 

Next Steps

Once your agreements are completed and API keys issued.  The Aline Integrations team will establish the API user in the partnered client's CRM environment and connect your API keys.  Once this step is complete, you are free to push tests into the client environment.  Tests can easily be deleted by CRM admin users or the Aline team. 

For 2.0 connections you will need the community ID (aka NameUnique) for each community. This can found in the CRM admin section or requested from the Aline team.

For 3.0 connections you will need the community NameUnique's and the portal ID for the client. This is also available from CRM admin users, or by request from the Aline team.