Aperçu

Optave fournit deux méthodes principales d'intégration : les APIs REST et les connexions WebSocket. Les deux interfaces supportent la gamme complète de Messages et de Superpowers, vous permettant de choisir le meilleur modèle de communication pour vos besoins.

API WebSocket

L'interface WebSocket offre :

• Communication bidirectionnelle en temps réel
• Latence réduite pour les interactions continues
• Gestion efficace des flux de messages
• Surcharge réduite pour les requêtes multiples

API REST

Notre API REST est idéale pour :

• Modèles simples de demande-réponse
• Interactions sans état
• Systèmes avec connectivité intermittente
• Environnements restreints par pare-feu

Authentification

L'envoi de messages, que ce soit via l'API REST ou l'API WebSocket, nécessite un jeton d'authentification.

Ce jeton peut être obtenu en appelant le point de terminaison d'authentification avec votre ID Client et votre Secret Client.

Votre URL de base

Remplacez {{tenant}} et {{tld}} par les valeurs fournies dans vos identifiants d'intégration Optave.

curl
  --request POST  
  --url https://{{tenant}}.oco.optave.{{tld}}/auth/oauth2/token?client_id=your-client-id-here&client_secret=your-client-secret-here \  
  --header "Content-Type": "application/x-www-form-urlencoded" 

Un jeton sera retourné dans un objet JSON :

{
  "access_token": "your-access-token-here"
}

Ce jeton peut ensuite être inclus dans un en-tête Authorization lors de l'envoi de messages :

curl
  --request POST  
  --url https://{{tenant}}.oco.optave.{{tld}}/message/adjust \  
  --header "Authorization: Bearer your-access-token-here" \  
  --header "Content-Type: application/json" \  
  -d '{ payload-here }'

Vous n'utilisez pas le SDK ?

Si vous envoyez des messages WebSocket directement sans le SDK JavaScript Optave, incluez "sdkVersion": "none" dans les headers de votre enveloppe de message WebSocket :

{
  "action": "message",
  "headers": {
    "sdkVersion": "none"
  },
  "payload": {
    "session": { "..." : "..." },
    "request": { "..." : "..." }
  }
}