• Quick Start Guide

šŸš€ Get up and running in 5 minutes! This section will help you make your first successful API call and understand which integration path is right for you.

5-Minute Setup

Step 1: Get Your Credentials Contact Okinus support at support@okinus.com to receive your sandbox credentials:

  • store_id (e.g., "12345")
  • retailer_slug (e.g., "your-company")
  • store_slug (e.g., "main-store")
  • API Token (for server-side calls)

Step 2: Test Your Connection Make a simple test call to verify your credentials work:

Test Your Connection

GET
/api/v1/test
curl -X GET "https://beta2.okinus.com/api/v1/test" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"

Expected Response

{
"status": true,
"code": 200,
"message": "API connection successful"
}

Choose Your Integration Path

šŸ¤” Not sure which integration type to choose? Use this decision tree:

Do you use an existing e-commerce platform?
ā”œā”€ā”€ Yes: Magento or WooCommerce?
│   ā”œā”€ā”€ Yes → Use E-commerce Plugins 
│   └── No → Use Checkout Integration 
└── No: Building a custom solution?
    └── Yes → Use Direct API Integration 

Integration Options:

Integration TypeBest ForTime to ImplementComplexity
E-commerce PluginsMagento, WooCommerce stores🟢 Easy
Checkout IntegrationCustom checkout flows🟔 Medium
Direct APIFull custom controlšŸ”“ Advanced

Your First API Call

Let's make your first meaningful API call - checking if a customer qualifies for leasing:

// Load the Okinus JavaScript library
<script src="https://js.okinus.com/v1/checkout.js"></script>
<script>
const okinus = Okinus({
    baseUri: "https://beta2.okinus.com/",
    retailerSlug: "YOUR_RETAILER_SLUG",
    storeSlug: "YOUR_STORE_SLUG"
});

// Add a simple "Apply for Credit" button
document.getElementById('apply-btn').addEventListener('click', () => {
    okinus.apply((result) => {
        if (result.status === 'approved') {
            console.log('šŸŽ‰ Customer approved!', result);
        } else {
            console.log('Application result:', result);
        }
    });
});
</script>

Next Steps

āœ… Once you've successfully made your first API call:

  1. Choose your path: Based on the decision tree above, jump to the Getting Started section to choose your integration path:
    • E-commerce Plugins - For Magento/WooCommerce
    • Checkout Integration - For custom checkout flows
    • Direct API Integration- For full API control
  2. Set up webhooks: Configure real-time notifications in Webhooks API
  3. Test thoroughly: Use our Testing Guide with test data
  4. Go live: Follow our Production Deployment checklist

šŸ†˜ Need help? Check our FAQs or contact support@okinus.com