Introduction
Welcome to the Typograph Developer Documentation.
Typograph is a creative automation platform for building, editing, and publishing typographically rich documents — templates, flyers, POD products, marketing collateral and more — either through our web Portal or programmatically through the API.
What You'll Find Here
- Guides — step-by-step tutorials for integrating the browser scripts and the REST API
- Portal Documentation — end-user guides for the Typograph Portal
- OpenAPI Reference — interactive Swagger UI for the REST API
Platform Surface
Typograph exposes its capabilities through three complementary surfaces:
| Surface | Audience | Documented In |
|---|---|---|
| REST API | Any backend or client that can speak HTTP | Guides → API |
| Browser scripts | Web apps embedding the Editor or Viewer | Guides → Integration |
| MCP Server | AI assistants (Claude, etc.) | AI Agents (MCP) |
All three ultimately go through the same API Gateway, which handles OAuth 2.0 authentication, scope-based authorization, tiered rate limiting, and routing to the underlying services.
Browser Scripts
The Editor and Viewer are delivered as CDN-hosted scripts — no npm package install is required.
| Script | Purpose | CDN URL |
|---|---|---|
| Editor | Full document editing UI | https://cdn.typograph.nl/editor/latest/editor.js |
| Viewer | Read-only template filling UI | https://cdn.typograph.nl/editor/latest/viewer.js |
Both are constructed from the same bundle family and expose a window.typograph global, communicating with your page through DOM events and callback registration. See Editor Integration and Viewer Integration.
Quick Links
- Installation — create your first OAuth client and obtain credentials
- Quick Start — obtain a token and call the API
- Authentication — OAuth 2.0 flows (Client Credentials, Authorization Code + PKCE, Refresh)
- Core Concepts — the document model (templates, pages, elements, swatches)
- Support — contact, FAQ, status