Integration
This section is the operator path for connecting your product to Zyphe: hosts, keys, sandbox, HTTP session creation, mobile WebView, and media export.
It sits alongside:
| Guide | Role |
|---|---|
| SDK Integration | npm packages (@zyphe-sdk/node, browser, React Native helpers) |
| Webhook | Receiving and verifying result deliveries |
| API keys | Secret vs publishable credentials (Dashboard) |
| Agents (MCP) | AI-assisted flow and key setup |
You do not need an npm package to integrate. The HTTP SDK API on https://api.zyphe.com is enough.
Start here
- Environment setup — API vs verify vs docs hosts,
.envtemplate - Sandbox mode —
sandboxflag, URL path, mismatch behavior - Backend API integration — create session → compose URL → open UI → webhook
- Mobile integration — no native SDK; WebView pattern
- Hosted UI vs direct API — when not to reimplement capture
- Export API — document images (not in webhooks by default)
- Sandbox and go-live — checklist before production traffic
Decision shortcuts
| You are… | Open… |
|---|---|
| Calling Zyphe from any backend language | Backend API integration |
| Building iOS / Android / React Native | Mobile integration |
| On TypeScript and prefer packages | SDK Integration |
| Capturing documents in your own camera UI | Hosted UI vs direct API |
Getting invalid_api_key or wrong-host errors | Environment setup · API keys |
Product-level comparison of public link vs backend vs SDK vs MCP: Choosing an integration method.