with Otomatika Gateway#
Get up and running with Otomatika Gateway in just a few simple steps. Our platform is designed to get you connected to your marketing platforms quickly and securely.Quick Start Guide#
Step 1: Create Your Account#
During registration, you'll create your organization profile and become the Tenant Owner with full access to manage your account.Organization/company name
Password (minimum 8 characters)
Your tenant (organization) is automatically created
You become the Tenant Owner with full administrative privileges
You can immediately start setting up platform integrations and API access
Step 2: Get Your API Key#
Once logged in, you'll need to generate your API key for programmatic access:1.
Navigate to Settings → API Keys in your dashboard
3.
Copy and securely store your API key - you'll need this for all API requests
4.
⚠️ Important: Keep your API key secure and never share it publicly
Authenticate all API requests to Otomitka Gateway
Create and manage members (end users)
Access workspace and platform integration endpoints
Ensure all operations are isolated to your tenant
Store your API key in environment variables
Never commit API keys to version control
Use different keys for development and production environments
Before you can use our API endpoints, you need to connect the marketing platforms you want to integrate:1.
Go to Platform Integrations in your dashboard
3.
Select your platform (Meta, Google, TikTok, X, LinkedIn, or Shopify)
4.
Enter your platform credentials:App ID: Your platform's application ID
App Secret: Your platform's secret key
Config ID: Platform-specific configuration ID (if required)
5.
Click "Connect" - we'll automatically generate your redirect URL
| Platform | Description | Required Credentials |
|---|
| Meta | Facebook & Instagram Ads | App ID, App Secret |
| TikTok | TikTok Ads | App ID, App Secret |
| Google | Google Ads | Client ID, Client Secret |
| X | Twitter Ads | API Key, API Secret |
| LinkedIn | LinkedIn Ads | Client ID, Client Secret |
| Shopify | E-commerce Integration | API Key, API Secret |
Where to find platform credentials:Shopify: Your Shopify Admin → Apps → Develop apps
Step 4: Start Making API Calls#
You're all set! Now you can start using our API endpoints. All requests must include your API key in the header.Base URL#
https://gateway.otomatika.com/api/v1
Common Integration Patterns#
Pattern 1: Backend Integration (Recommended)#
Keep your API key secure by calling Otomitka from your backend:Pattern 2: User Sign-In Flow#
Authenticate members and manage JWT tokens:Pattern 3: Workspace Operations#
Access and manage workspaces using member JWT tokens:
Interactive API Documentation#
Explore all available endpoints using our Swagger documentation:Test requests directly from your browser
View request/response schemas
Copy code examples in multiple languages
Next Steps#
Now that you're set up, explore these guides to build your integration:Core Concepts#
Advanced Topics#
Platform Integration APIs (Coming Soon) - Connect ad accounts and manage campaigns
Webhooks & Events (Coming Soon) - Real-time notifications
Rate Limiting & Best Practices (Coming Soon) - Optimize your integration
Troubleshooting#
Common Issues#
Issue: 403 Forbidden ErrorCause: Invalid or missing API key
Solution: Verify your API key is correctly set in the x-api-key header
Cause: Invalid or expired JWT token
Solution: JWT tokens expire after 24 hours. Have the member sign in again to get a new token
Cause: A member with that email already exists in your tenant
Solution: Check if the member already exists before creating, or use sign-in instead
Cause: Incorrect platform credentials or missing redirect URL
Solution: Double-check your App ID and App Secret in the dashboard. Ensure your platform app settings include the Otomitka redirect URL
Getting Help#
2.
Review error messages carefully - they often include specific guidance
4.
Include your request ID and error details for faster resolution
Security Checklist#
Before going to production, ensure:✅ API keys are stored in environment variables, not code
✅ API keys are never committed to version control
✅ HTTPS is used for all API requests
✅ JWT tokens are stored securely (httpOnly cookies or server sessions)
✅ Token expiry is handled gracefully in your application
✅ Rate limiting is implemented on your authentication endpoints
✅ User input is validated before sending to Otomitka
✅ Error messages don't expose sensitive information to end users
Support & Resources#
Modified at 2025-10-08 14:39:40
