Prerequisites
Before integrating MIMS SDK, ensure your development environment meets these requirements.
System Requirements
Runtime Environment
| Prop | Type | Default | Description |
|---|---|---|---|
Node.js | ≥ 18.0.0 | — | Required for build tools and development server |
React | ≥ 18.0.0 | — | The SDK uses React 18 features like useSyncExternalStore |
React DOM | ≥ 18.0.0 | — | Required for DOM rendering |
Optional but Recommended
| Prop | Type | Default | Description |
|---|---|---|---|
TypeScript | ≥ 5.0.0 | — | Full type definitions included for best DX |
ESLint | ≥ 8.0.0 | — | Helps catch common issues during development |
Browser Support
MIMS SDK supports all modern browsers. Internet Explorer is not supported.
| Prop | Type | Default | Description |
|---|---|---|---|
Chrome | ≥ 90 | — | Full support |
Firefox | ≥ 90 | — | Full support |
Safari | ≥ 14 | — | Full support |
Edge | ≥ 90 | — | Full support (Chromium-based) |
API Key
To use MIMS SDK, you need a valid API key from your MIMS dashboard. There are two types of keys:
Publishable Key (pk_)
Safe to use in client-side code. Has limited permissions for SDK operations only.
Secret Key (sk_)
For server-side use only. Has full API access. Never expose in browser.
Important
Always use publishable keys (
pk_ prefix) in your React application. Secret keys should only be used in server-side code (API routes, server components, etc.).Obtaining API Keys
- Create an account at mims-tech.com/register
- Navigate to your Dashboard → Settings → API Keys
- Click "Create API Key" and select the appropriate scopes
- Copy your publishable key for client-side use
Framework Compatibility
MIMS SDK is compatible with all major React frameworks:
| Prop | Type | Default | Description |
|---|---|---|---|
Next.js | 13+ (App Router & Pages Router) | — | Full support including Server Components |
Remix | 1.0+ | — | Full support |
Vite | 4.0+ | — | Full support |
Create React App | 5.0+ | — | Full support |
Gatsby | 5.0+ | — | Full support |
Package Dependencies
The SDK has minimal peer dependencies:
package.json (peer dependencies)json
{
"peerDependencies": {
"react": ">=18.0.0",
"react-dom": ">=18.0.0"
}
}The following dependencies are bundled with the SDK:
- pdfjs-dist - PDF rendering engine
- zustand - State management for document store
- react-konva - Canvas rendering for signature pad
Network Requirements
The SDK requires network access to:
api.mims-tech.com- API endpoints for validation and submission- Your document storage URLs - For loading PDF documents
Self-Hosted Option
For enterprise customers, MIMS can be deployed on-premises. Contact sales for more information about self-hosted deployments.
Development Tools
We recommend the following tools for the best development experience:
- VS Code with TypeScript and ESLint extensions
- React DevTools browser extension for debugging
- Network tab in browser DevTools for API debugging
Next Steps
Once you have verified all prerequisites: