Want to build your own Acrolinx custom integration? Here's what the process entails:
 |
The process from kickoff to API compatibility certification.
To learn more about each of the steps in the diagram above, read on:
Here are some good questions to think about:
-
What kind of integration do you want to develop?
Acrolinx Integration into your editing tool to help your writers
Automated check analyzes all the content in your CMS (content management system) and provides Scorecards for each document
Both
-
What kind of application do you want to use with Acrolinx?
-
Authoring tool
Is your tool a desktop or web application?
Are the APIs sufficient for integrating Acrolinx?
If web application, do you use a rich text editor (RTE) like TinyMCE, CKEditor, CodeMirror, or a customer-built editor?
-
Server-based application
Is it a CMS?
Is it web based?
What language is it in: Java, .NET, JavaScript, other?
Is it a proprietary CMS or a known CMS vendor like Ixiasoft, Astoria, SDL?
Is it hosted in the public cloud, private cloud, or on-premise behind the firewall?
Can you use the APIs to integrate Acrolinx?
-
-
What's the native file format of the content that you want Acrolinx to analyze?
See the supported input types.
Acrolinx supports some file types natively.
If a file type isn't supported natively, it's transformed to a native format that Acrolinx supports
If Acrolinx doesn't support your file type, you can also transform it as part of your custom integration
-
Who are the target users of the Acrolinx Integration?
Writers - guidance in authoring tools
Managers - governance in Analytics dashboards
Project managers - governance or quality gate for a workflow, for example, readiness of content for publishing or translation
-
How would you like users to sign in?
Acrolinx sign-in - Users need to sign in before they can use the Sidebar or any integration
Single sign-on (SSO) - Users or API integrations are signed in automatically without having to enter their sign-in details. Learn how to set up Acrolinx for single sign-on.
Use SAML and PingFederate to Authenticate Users - Connect Acrolinx to your identity provider so you don't have to manage users and passwords in Acrolinx
Use an API token for authentication - Create an API token to authenticate your automated check integration instead of using a username and password
-
How will Acrolinx run?
Note
This only applies to integrations that offer an automated check option.
Regularly by interval
Workflow step starts automated check
Initiated manually by a person
Acrolinx carefully chooses which integrations to own and build. It's a big engineering investment to learn an entirely new application.
Sometimes it makes more sense to partner with experts who have all the domain knowledge. That's why Acrolinx also has an ecosystem of partners that help us address a wider range of needs. Learn more about becoming an Acrolinx partner.
As part of the developer program, we schedule a project kickoff with you and your developers to answer questions upfront. We'll explain the basics of Acrolinx and:
Where and how do you want to embed Acrolinx?
Agree on scope and timeline
Make sure that the developer can get started
Sign SDK usage contract
Notice
Acrolinx doesn’t do a comprehensive certification of all functionality of the integration. The developer is responsible for the feature scope and testing.
Developer integrates Acrolinx, makes sure it's working, and makes sure the integration is API compatible before release.
Develop
Start with a PoC (proof of concept)
Use SDKs in GitHub
Follow best practices in the developer documentation
Review the checklist in the Acrolinx coding guidance before requesting API compatibility certification
Use the debug button in the Sidebar to review the integration properties and document check request
Test
Complete standard test cases and uses the Request Validator for feedback.
Developer is responsible for complete testing
Certify
Developer demonstrates the integration with the latest version of the Acrolinx Platform
Developer shows that the integration meets the minimum requirements
Acrolinx reviews document structure and other configurations
-
Acrolinx makes sure that you can use the integration
Basic authoring
Content reference in Analytics
Acrolinx verifies that the integration follows the license model
Acrolinx gives the developer a permanent signature for the integration so writers can use it