Mise en route

Introduction

Oquira fournit une API puissante pour la gestion des files d'attente en temps réel, la découverte de services et l'analyse commerciale. Ce guide vous aidera à effectuer vos premiers appels API et à comprendre nos concepts de base.

Endpoints API

Authentification

Pour utiliser l'API, vous avez besoin d'une Clé API Business.

Obtenir vos clés API

1. Connectez-vous au Oquira Business
2. Naviguez vers Paramètres > Clés API
3. Générez une nouvelle clé ou copiez une clé existante
4. Assurez-vous que votre clé dispose des permissions nécessaires (portées)

Utiliser votre clé API

Incluez votre clé API dans l'en-tête X-API-Key :

X-API-Key: votre_cle_api_ici

Votre Premier Appel API

Effectuons une requête simple pour lister les files d'attente de votre organisation.

Avec cURL

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

Avec JavaScript (Fetch)

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

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

Avec Python (requests)

import requests

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

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

print(response.json())

Réponse Attendue

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

Étapes Suivantes

Maintenant que vous avez effectué votre premier appel API, explorez davantage :

• Authentification - Apprenez la gestion des clés API et des tokens de session
• Réponses - Comprenez nos conventions de format de réponse
• Erreurs - Gérez les erreurs de manière élégante dans votre intégration
• Services - Gérez vos services commerciaux
• Files d'attente - Gérez le flux client et les tickets
• Référence API - Documentation complète des endpoints