Prise en main de l’API #

L’API REST Your AI Connector vous permet de créer votre propre intégration au-dessus de votre compte. Vous pouvez créer et consulter des contacts, gérer des campagnes, des FAQ, des tâches et des rendez-vous, envoyer des messages, enregistrer des webhooks, lire des analyses et connecter des canaux de messagerie — tout ce que fait le tableau de bord, piloté par le code.

Ceci est la page centrale de la documentation de l’API. Si vous connectez Your AI Connector à un outil qui dispose déjà d’une intégration intégrée, vous n’aurez peut-être pas besoin de l’API. L’API est destinée aux intégrations personnalisées et à l’automatisation à grande échelle.

URL de base #

Chaque requête est envoyée à la même adresse web de base, et tous les chemins dans ces documents lui sont relatifs :

https://api.youraiconnector.com/v1

Ainsi, le point de terminaison des campagnes est https://api.youraiconnector.com/v1/campaigns, le point de terminaison des contacts est https://api.youraiconnector.com/v1/contacts, et ainsi de suite.

Toutes les requêtes doivent utiliser une connexion sécurisée (HTTPS). Les requêtes HTTP simples sont rejetées.

Obtenir une clé API #

L’accès à l’API est une fonctionnalité payante. Si votre forfait ne l’inclut pas, chaque requête renvoie une 403 avec ce corps :

{
  "success": false,
  "error_code": 403,
  "error": "This action requires the \"api_access\" feature, which is not enabled for this account."
}

Une fois l’accès à l’API activé sur votre forfait, générez une clé depuis le tableau de bord. La procédure étape par étape complète se trouve dans Accès API — en résumé : allez dans Paramètres → Intégrations → Clé API pour générer ou régénérer votre clé. La section Clé API est distincte sous Intégrations, séparée des Webhooks, et elle n’apparaît qu’une fois l’accès à l’API activé sur votre forfait. Traitez cette clé comme un mot de passe : elle donne un accès complet à votre compte.

Authentification #

Vous pouvez envoyer votre clé API de quatre manières. Toutes fonctionnent sur chaque point de terminaison qui accepte l’authentification par clé API.

Pour la production, privilégiez l’une des formes d’en-tête afin que votre clé ne se retrouve jamais dans un journal de serveur ou dans l’historique du navigateur. La forme de paramètre de requête fonctionne toujours et est la plus simple pour un test ponctuel.

Consultez Authentification pour une analyse complète de chaque méthode, avec des exemples et des conseils sur le moment d’utiliser laquelle.

Votre première requête #

Voici un appel complet et fonctionnel qui liste les campagnes de votre compte. Il utilise votre clé API et renvoie les campagnes les plus récentes en premier.

cURL

curl "https://api.youraiconnector.com/v1/campaigns?apiKey=YOUR_API_KEY&limit=10"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/campaigns?limit=10", {
  headers: {
    "X-API-Key": "YOUR_API_KEY",
  },
});

const data = await res.json();
console.log(data.campaigns);

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/campaigns",
    params={"limit": 10},
    headers={"X-API-Key": "YOUR_API_KEY"},
)

data = res.json()
print(data["campaigns"])

Une réponse réussie ressemble à ceci :

{
  "success": true,
  "campaigns": [
    {
      "id": "NBCXrhqGPSFsd6MV7pRo",
      "name": "Inbound WhatsApp Leads",
      "type": "Incoming from Unknown Contacts",
      "status": "Live",
      "enabled": true,
      "archived": false,
      "created_at": 1700000000000,
      "ai_mode": true,
      "language": "en",
      "enabled_channels": ["whatsapp", "instagram"]
    }
  ],
  "next_cursor": null
}

Réponses de succès et d’erreur #

Chaque réponse JSON comporte un indicateur success afin que vous puissiez effectuer des branchements sans avoir à analyser les codes de statut.

Une réponse réussie est success: true accompagnée des données pour ce point de terminaison (le nom du champ varie — campaigns, contacts, data, etc.) :

{
  "success": true,
  "campaigns": []
}

Une réponse en échec est success: false avec un message error lisible par l’humain et un error_code numérique qui correspond au statut HTTP :

{
  "success": false,
  "error": "Invalid cursor",
  "error_code": 400
}

Vérifiez toujours success (ou le statut HTTP) avant de lire les données. Consultez Erreurs et pagination pour obtenir le tableau complet des codes de statut et savoir comment paginer les grands ensembles de résultats.

Limites de débit #

Les requêtes authentifiées sont limitées à 300 requêtes par minute par clé API. Il existe également un plafond plus large de 1 200 requêtes par minute par compte, qui comptabilise toutes les requêtes authentifiées effectuées pour ce compte.

Si vous dépassez l’une ou l’autre de ces limites, vous recevrez une réponse 429 :

{
  "success": false,
  "error_code": 429,
  "error": "Rate limit exceeded. Please try again later."
}

Attendez un court instant avant de réessayer. Vous pouvez également vérifier votre utilisation actuelle à tout moment avec GET https://api.youraiconnector.com/v1/api-keys/usage, qui renvoie le nombre de requêtes que vous avez effectuées dans la fenêtre actuelle et le moment où elle se réinitialise — utile pour créer une limitation côté client. Consultez Clés API.

Guides des ressources #

Les groupes de ressources ci-dessous disposent chacun de leur propre guide avec les chemins exacts, les champs de requête et les structures de réponse.

Agents, points d’entrée et diffusions #

Les agents IA, les points d’entrée et les diffusions sont tous inclus dans la spécification OpenAPI publiée, vous pouvez donc parcourir leurs champs exacts et exécuter des requêtes en direct dans l’explorateur d’API. Chacun dispose de son propre guide : Agents IA, Points d’entrée et Diffusions.

Lire cette documentation au format Markdown #

Chaque page de cette documentation possède un équivalent en Markdown brut : prenez l’adresse de la page et ajoutez /index.md à la fin. Cette page est donc également disponible à l’adresse https://docs.youraiconnector.com/api/getting-started/index.md, et elle est renvoyée sous forme de texte brut plutôt que de page web — pratique lorsque vous souhaitez coller une page dans un assistant IA ou l’intégrer dans un script.

Pour parcourir l’ensemble, commencez par https://docs.youraiconnector.com/sitemap.xml, qui répertorie toutes les pages que nous publions. Notez que la documentation est volontairement exclue des moteurs de recherche, donc récupérer ces adresses directement est le moyen d’y accéder depuis du code.

Il n’existe pas encore de point de terminaison de documentation protégé par clé ni de téléchargement en masse — les équivalents Markdown et le plan du site constituent toute l’interface, et aucun des deux ne nécessite de clé API.

Étapes suivantes #

• Authentification — choisissez la méthode d’authentification adaptée à votre intégration.
• Erreurs et pagination — gérez les échecs et parcourez les résultats par page.
• Accès API — générez votre clé et consultez des exemples concrets.