Skip to content

Voki APIPlateforme de Visioconférence

Documentation complète de l'API REST et WebSocket pour l'intégration avec la plateforme Voki v4.0

Vue d'ensemble

L'API Voki vous permet d'intégrer et d'automatiser toutes les fonctionnalités de la plateforme de visioconférence. Construite sur Elixir/Phoenix, l'API offre :

  • Authentification JWT avec support MFA (TOTP)
  • Multi-tenancy avec isolation complète par tenant
  • CRUD complet pour toutes les entités du système
  • Analytics en temps réel avec vues matérialisées
  • WebSocket pour la communication bidirectionnelle
  • Webhooks Asaas pour la facturation automatisée

Base URL

https://voki.avanter.com.br/api/

Format de Réponse

Toutes les réponses suivent le même format :

Succès (objet)

json
{
  "data": {
    "id": "uuid",
    "field": "value"
  }
}

Succès (liste paginée)

json
{
  "data": [...],
  "meta": {
    "current_page": 1,
    "page_size": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Erreur de validation

json
{
  "errors": {
    "email": ["ne peut pas être vide"],
    "name": ["doit contenir au moins 2 caractères"]
  }
}

Erreur générique

json
{
  "errors": {
    "detail": "Non autorisé"
  }
}

Rate Limiting

EndpointLimite
/api/auth/*5 requêtes/minute
Endpoints publics30 requêtes/minute
Endpoints authentifiésPas de limite explicite

Documentação da API Voki v4.0