Getting Started

Step 1: Choose Your Integration Path

  • E-commerce Plugins- Magento/WooCommerce
  • Checkout Integration - Custom checkout
  • Direct API - Full control

Need help deciding? Use our decision matrix:

Your SituationRecommended PathWhy
Using Magento or WooCommerceE-commerce PluginsPre-built, tested, minimal coding
Custom e-commerce platformCheckout IntegrationFlexible, moderate complexity
Need full control/customizationDirect APIMaximum flexibility, requires more development
Just exploring/prototypingQuick Start GuideGet hands-on experience first

Step 2: Get Your Credentials

📧 Contact Okinus Support:

  • Email: support@okinus.com
  • Phone: 1-800-472-1334
  • What to request: "Sandbox API credentials for your company integration"

📋 Information you'll need to provide:

  • Company name and website
  • Integration type (from Step 1)
  • Technical contact information
  • Expected go-live timeline

🔑 Credentials you'll receive:

  • store_id - Your unique store identifier (e.g., "12345")
  • API Token - For server-to-server authentication
  • retailer_slug - For JavaScript library (e.g., "your-company")
  • store_slug - For JavaScript library (e.g., "main-store")
  • Sandbox base URL: https://beta2.okinus.com/

⏱️ Timeline: Typically receive credentials within 1-2 business days.

Step 3: Set Up Your Development Environment

🛠️ Required Tools:

  • Code editor (VS Code, Sublime, etc.)
  • Web server (local development server)
  • API testing tool (Postman, curl, or browser dev tools)

📚 Optional Resources:

Step 4: Understand the Environments

EnvironmentPurposeBase URLData Impact
SandboxDevelopment & Testinghttps://beta2.okinus.com/✅ Safe - No real transactions
ProductionLive Customer Transactionshttps://www.okinushub.com/⚠️ Real money - Real customers

Step 6: Plan Your Implementation

📋 Implementation Checklist:

Phase 1: Basic Integration

  • Complete Quick Start Guide
  • Implement chosen integration path
  • Test with sandbox data
  • Handle basic success/failure scenarios

Phase 2: Production Readiness

  • Implement error handling
  • Set up webhook endpoints
  • Complete security review
  • Test all user scenarios

Phase 3: Go Live

  • Submit proof-of-concept
  • Receive production credentials
  • Deploy to production
  • Monitor and optimize

🎯 Success Metrics:

  • Successful test transactions in sandbox
  • All error scenarios handled gracefully
  • Webhook events processed correctly
  • Security best practices implemented