Integration

Integrating Exponential with other systems: the APIs, feeds, imports, exports and search.

63 pages

Security for integrations The security rules an Exponential integration must follow - credentials never in Git, settings/override and the environment, least privilege for service accounts, transport security, input from other systems treated as… AdministratorsDevelopersIntegrators Integration
Service accounts, roles and policies Giving an integration exactly the rights it needs - a service account per integration, a user group and a role of its own, the policies typical integrations need (content read, create, edit, remove, apikey/create… AdministratorsDevelopersIntegrators Integration
Caching after imports Which caches an import or a sync touches and which it does not - what the publish operation clears on its own, when to clear more, the cache ids of ezcache.php, the HTTP cache and Velocity's response cache, caches after… AdministratorsDevelopersIntegrators Integration
Velocity and performance for integrations What Velocity, the persistent-worker web server of Exponential, means for integrations - classes loaded at start, statics that survive requests, deploying a changed integration, which API answers the response cache may… DevelopersHosting companiesIntegrators Integration
Testing integrations A test strategy for Exponential integrations - unit tests without a database for mappings and parsers, test doubles for the other system, script tests with the kernel loaded, dry runs on a copy, the idempotency test… DevelopersIntegrators Integration
Monitoring integrations Knowing that an integration works before the customer notices that it does not - what to watch (runs, freshness, backlog, errors, credentials), the signals Exponential provides (summary lines, cronjob pages, the audit… AdministratorsHosting companiesIntegrators Integration
Upgrades without breaking integrations Keeping integrations working through Exponential, extension and PHP upgrades - what tends to change under an integration, reading the behavior change notes, pinning versions with Composer, a rehearsal on a copy… AdministratorsDevelopersIntegrators Integration
Building an integration as an extension Packaging an integration as an Exponential extension - the directory layout of a typical integration, settings with secrets kept in settings/override, classes, commands, cronjob parts, workflow events, schema, tests… DevelopersIntegrators Integration
Contributing integrations back What integrators can give back to Exponential and why it pays - fixes found while integrating, generic connectors as public extensions, documentation of an integration pattern - how to separate generic from customer… DevelopersPartnersIntegrators Integration
Integration project playbook A phase-by-phase playbook for integration projects around Exponential - discovery, interface design, environments and access, build, test, go-live, hypercare and handover - with deliverables, the roles involved on both… Project managersPartnersIntegrators Integration
Estimating integration work How to estimate an integration with Exponential - breaking it into flows and work items, the factors that drive effort (surface, volume, data quality, the other system's API, identity, testing, operations), a worksheet… Project managersPartnersIntegrators Integration
Statements of work for integrations What a statement of work for an Exponential integration should contain - scope per flow, deliverables, customer obligations, assumptions, acceptance, change requests, ownership and licensing of the code, data… Project managersPartnersIntegrators Integration
Handover of an integration Handing an integration over to the people who will operate it - the handover package (code, documentation, runbook, monitoring, credentials inventory), the runbook's sections, transferring credentials safely, training… AdministratorsProject managersIntegrators Integration
Integrators and the partner program How integration companies fit into the Exponential Partner Program - the profiles and levels that suit integrators, what the program offers (support tickets, referrals, visibility), lead commissions, how to join, and… PartnersIntegrators Integration
Integration discovery worksheet A worksheet to fill in with the customer at the start of an integration project - the installation, the systems around it, every data flow with direction, timing, volume, keys and owners, identity, constraints, and the… Project managersIntegrators Integration
Interface specification template A template for specifying one integration flow with Exponential - purpose, parties, surface and endpoints, authentication, data mapping and keys, timing and volume, error handling, security, monitoring, test and… DevelopersProject managersIntegrators Integration
Integration security checklist A checklist for the security review of an Exponential integration before go-live and once a year - credentials, accounts and roles, transport, input handling, outbound calls, logging, audit, data protection and incident… AdministratorsDevelopersIntegrators Integration
Integration go-live checklist The checklist for taking an Exponential integration live - readiness, the initial load, switching schedules and hooks on, monitoring, the first runs, rollback, and the first days of hypercare - with the commands for… AdministratorsProject managersIntegrators Integration
Integrators' FAQ Short answers to the questions integrators ask most about Exponential - APIs, authentication, webhooks, imports, identity, search, performance, upgrades, licensing and the partner program - each with a link to the page… DevelopersProject managersIntegrators Integration
Integrators' glossary The terms integrators meet when connecting Exponential with other systems - Exponential's own concepts (class, object, node, remote id, siteaccess, operation, trigger, cronjob part) and general integration terms… DevelopersProject managersIntegrators Integration

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x