Interfaces & Integrations
primedocs can be integrated into existing systems as well as be called from other systems — from data retrieval and web embedding to automated document generation. In addition, user data can be kept up to date via user synchronization.
Interface Options
- Connect — Automate document creation processes via the Connect interface. Connect allows partial or complete automation of document generation.
- Select — Access address data and generic data from various systems via primedocs Select.
- API — Call primedocs information and document generation via the Web API (Admin API, Connect API, Connect Session API).
- MCP — Expose primedocs capabilities to AI agents (e.g. Microsoft 365 Copilot) via the Model Context Protocol.
- Connected Services — External services that primedocs authenticates against on the user's behalf (used by InvokeUrl, HttpDataProvider, and Connect Sessions).
- Web Integration — Embed primedocs web into other web applications such as CMI, SharePoint, or Microsoft Teams.
- Electronic Signatures — Prepare documents for e-signature services such as DeepSign, Adobe Acrobat Sign, or DocuSign via placeholder texts in the templates.
- Export as Template — Export primedocs templates for third-party systems as "normal" Office templates stamped with meta information, in case the target system does not offer any extension options.
- Protocol Handler — Invoke the primedocs Desktop Client from other applications, links or scripts via the
primedocs:URL protocol (create a new document, control the window, trigger Connect).
3rd Party / Product Integrations
primedocs can integrate into your existing product ecosystem. Depending on the type of product, various integration methods are available.
Integration Examples
Info The following list is not exhaustive and illustrates example integrations with business applications and surrounding systems.
Types of integration:
- Core component of primedocs
- Authentication
- User synchronization
- Select
- Connect
- Web integration
- Partner integration
| Product | Integration type | Description |
|---|---|---|
| Microsoft Office | Core component of primedocs | primedocs integrates with Office both via COM Add-ins and modern Office.js-based Add-ins. |
| Active Directory / Entra Id (Azure Active Directory) | Authentication & User Synchronization | For authentication (see Server Installation), primedocs can access the existing Active Directory or Entra ID infrastructure. At the same time, it also serves as the source for User synchronization. |
| CMI | Connect, Web Integration, Select | Start document creation from CMI Desktop (Connect) or CMI Web (Connect Session Template), use CMI business cases as a data source, and write documents back to CMI. See CMI |
| Microsoft SharePoint | Web Integration | See SharePoint |
| Microsoft Teams | Web Integration | See Teams |
| TelSearch | Select | See HttpDataProvider |
| InnoSolv | Select | See HttpDataProvider |
| Vertec | Select | See HttpDataProvider or AddressService |
| Microsoft SQL Server | Core Component of primedocs, User Synchronization, Select | See SqlDataProvider |
| Oracle | User Synchronization, Select | See SqlDataProvider |
| MySQL | User Synchronization, Select | See SqlDataProvider |
| MariaDB | User Synchronization, Select | See SqlDataProvider |
| IBM System i | User Synchronization, Select | See SqlDataProvider |
| Microsoft Excel / CSV | User Synchronization, Select | See ExcelDataProvider / CsvDataProvider / ExistingListDataProvider |
| SCIM | Authentication & User Synchronization | See SCIM |
| DeepSign / Adobe Acrobat Sign / DocuSign | Partner Integration | Address e-signature services via placeholder texts in the templates. See Electronic Signatures. |
note
Your use case is missing from the list or you have specific implementation questions? Contact us via our Helpdesk — we welcome new integration possibilities!
Connect Variants
To allow a business application to directly trigger the document generation process, the primedocs Connect integration option can be used. Depending on the type of application and the use case, different variants are available:
| Type of application | Client type of primedocs | Integration via... | Data supply | Information |
|---|---|---|---|---|
| Desktop Application | primedocs desktop | Connect — Start document generation | Yes | |
| Desktop Application | primedocs Document Creation Server | Connect API — Connect API | Yes | Server-side document generation without user editing. |
| Web Application | primedocs web | Connect Session Template — Connect Session Templates | Yes | Embeds our web app into your own web application (see Web Integration). Data is supplied via URL parameters and the initializers of the Connect Session Template. |
| Web Application | primedocs Document Creation Server | Connect API — Connect API | Yes | Server-side document generation without user editing. |
| Web Application | primedocs desktop | Connect call via Protocol Handler | Yes | The web application can call the primedocs desktop client via protocol handler and pass a URL to an API that generates the Connect file. |