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/testcurl -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 Type | Best For | Time to Implement | Complexity |
|---|---|---|---|
| E-commerce Plugins | Magento, WooCommerce stores | š¢ Easy | |
| Checkout Integration | Custom checkout flows | š” Medium | |
| Direct API | Full 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:
- 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
- Set up webhooks: Configure real-time notifications in Webhooks API
- Test thoroughly: Use our Testing Guide with test data
- Go live: Follow our Production Deployment checklist
š Need help? Check our FAQs or contact support@okinus.com
