Points de terminaison de l'API

L'API Diamy est organisée autour de ressources RESTful. Toutes les requêtes doivent être envoyées à la base URLhttps://api.diamy.io/v1et retournent des données au format JSON.

Utilisateurs

Gérez les utilisateurs, leurs profils et leurs préférences.

Appels

Accédez aux données d'appels, gérez les enregistrements et les transcriptions.

Réunions

Planifiez, modifiez et gérez les réunions et leurs participants.

Analytiques

Récupérez des données analytiques et des rapports sur l'utilisation.

Structure des requêtes

Toutes les requêtes doivent inclure votre clé API dans l'en-tête d'authentification. Consultez la section Authentification pour plus de détails.

Exemple de requête

curl -X GET "https://api.diamy.io/v1/users" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Structure des réponses

Toutes les réponses sont renvoyées au format JSON. Les réponses réussies incluent généralement les données demandées, tandis que les erreurs incluent un code d'erreur et un message descriptif.

Exemple de réponse réussie

{
  "status": "success",
  "data": {
    "users": [
      {
        "id": "usr_123456",
        "name": "Jean Dupont",
        "email": "jean.dupont@example.com",
        "created_at": "2023-01-15T14:30:00Z"
      },
      // ...
    ]
  },
  "pagination": {
    "total": 42,
    "page": 1,
    "per_page": 10,
    "pages": 5
  }
}

Exemple de réponse d'erreur

{
  "status": "error",
  "error": {
    "code": "authentication_failed",
    "message": "Clé API invalide ou expirée",
    "status_code": 401
  }
}

Pagination

Pour les endpoints qui renvoient des listes d'objets, l'API utilise une pagination basée sur des pages. Vous pouvez spécifier la page et le nombre d'éléments par page à l'aide des paramètres de requête.

Paramètres de pagination

page - Le numéro de page (par défaut: 1)
per_page - Nombre d'éléments par page (par défaut: 10, max: 100)

Exemple de requête avec pagination

curl -X GET "https://api.diamy.io/v1/calls?page=2&per_page=25" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Conseil

Pour des performances optimales, limitez le nombre d'éléments par page à ce dont vous avez réellement besoin. Utilisez les filtres disponibles pour réduire le volume de données transférées.

Filtrage et tri

De nombreux endpoints prennent en charge le filtrage et le tri des résultats à l'aide de paramètres de requête. Consultez la documentation spécifique à chaque endpoint pour connaître les options disponibles.

Exemple de filtrage

curl -X GET "https://api.diamy.io/v1/calls?status=completed&date_from=2023-01-01&date_to=2023-01-31" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Exemple de tri

curl -X GET "https://api.diamy.io/v1/meetings?sort=start_time&order=desc" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Authentification Utilisateurs

Documentation