Getting Started

Introduction

Oquira provides a powerful API for real-time queue management, service discovery, and business analytics. This guide will help you make your first API calls and understand our core concepts.

API Endpoints

Authentication

To use the API, you need a Business API Key.

Get your API keys

1. Log in to the Oquira Dashboard
2. Navigate to Settings > API Keys
3. Generate a new key or copy an existing one
4. Ensure your key has the necessary permissions (scopes)

Using your API key

Include your API key in the X-API-Key header:

X-API-Key: your_api_key_here

Your First API Call

Let's make a simple request to list the queues in your organization.

Using cURL

curl -X GET "https://api.oquira.com/v1/business/queues" \
     -H "X-API-Key: your_api_key" \
     -H "Content-Type: application/json"

Using JavaScript (Fetch)

const response = await fetch("https://api.oquira.com/v1/business/queues", {
  headers: {
    "X-API-Key": "your_api_key",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

Using Python (requests)

import requests

headers = {
    "X-API-Key": "your_api_key",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://api.oquira.com/v1/business/queues",
    headers=headers
)

print(response.json())

Expected Response

{
  "success": true,
  "data": [
    {
      "id": "que_m2n8p1",
      "name": "Main Queue",
      "waitingCount": 5,
      "status": "active"
    }
  ]
}

Next Steps

Now that you've made your first API call, explore more:

• Authentication - Learn about API key management and session tokens
• Responses - Understand our response format conventions
• Errors - Handle errors gracefully in your integration
• Services - Manage your business services
• Queues - Handle customer flow and ticket management
• API Reference - Complete endpoint documentation