Accès à l’API #

Une API (interface de programmation d’application) est un moyen pour différents systèmes logiciels de communiquer entre eux. L’API Your AI Connector vous permet (ou permet à votre développeur) de créer automatiquement des contacts, d’envoyer des messages, de gérer des listes et de recevoir des messages entrants depuis des canaux personnalisés — le tout sans utiliser le tableau de bord.

Pourquoi utiliser l’API ? Si vous souhaitez connecter l’application à un outil qui ne dispose pas d’une intégration native, ou si vous avez besoin d’automatiser des tâches répétitives à grande échelle, l’API est la solution.

Génération de votre clé API #

1. Dans la barre latérale gauche, cliquez sur Paramètres (icône d’engrenage).
2. Dans la barre latérale des paramètres, sous le groupe Intégrations, cliquez sur Clé API.

3. Si vous n’avez pas encore de clé, cliquez sur Générer une clé API.
4. Si vous en avez déjà une, elle s’affiche masquée sous Votre clé. Si votre clé le permet, cliquez sur Afficher pour la révéler, puis sur Copier pour la copier — une notification de confirmation apparaîtra.
5. Conservez la clé dans un endroit sûr — vous en aurez besoin pour chaque requête API.

Membres de l’équipe : la clé API appartient au propriétaire du compte. Si vous êtes connecté en tant que membre d’équipe invité (y compris en tant qu’administrateur), la section affiche une note au lieu de la clé. Connectez-vous en tant que propriétaire du compte pour l’afficher, la copier ou la régénérer — cela s’applique également aux clés délimitées.

Où la trouver : Clé API est une section à part entière sous Paramètres → Intégrations, distincte des Webhooks. Si un guide ou un collègue vous dit de chercher la clé sous “Webhooks”, regardez plutôt dans la section juste à côté.

URL de base #

Toutes les requêtes API utilisent l’adresse web de base suivante :

https://api.youraiconnector.com/v1/

Authentification #

Chaque requête doit inclure votre clé API afin que la plateforme sache qu’il s’agit de vous. Le moyen le plus simple consiste à l’ajouter à la fin de l’adresse web :

https://api.youraiconnector.com/v1/contacts?apiKey=YOUR_API_KEY

Vous pouvez également envoyer la clé dans l’en-tête de la requête plutôt que dans l’URL (recommandé pour la production, afin que la clé ne se retrouve pas dans les journaux du serveur) :

X-API-Key: YOUR_API_KEY

Authorization: Bearer YOUR_API_KEY

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

Vous recherchez les guides complets pour développeurs ? Cette page est une introduction rapide couvrant les opérations les plus courantes. Pour des guides complets étape par étape — chaque ressource, avec des exemples en cURL, JavaScript et Python — consultez Démarrer avec l’API et la Référence de l’API.

Opérations API courantes #

Créer un contact #

Requête :

POST https://api.youraiconnector.com/v1/contacts?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+15551234567",
  "email": "jane@example.com"
}

Champs requis : un phoneNumber (avec code pays) est toujours requis pour créer un contact. Une adresse e-mail seule ne suffit pas — une requête sans numéro de téléphone valide est rejetée. L’e-mail est facultatif.

Réponse :

{
  "success": true,
  "data": {
    "message": "Successfully created new contact",
    "contactId": "abc123xyz",
    "listsAdded": []
  }
}

Enregistrez data.contactId — vous en aurez besoin pour l’appel “Ajouter un contact à une liste”.

Ajouter un contact à une liste #

POST https://api.youraiconnector.com/v1/contacts/lists?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "contactId": "abc123xyz",
  "listId": "YOUR_LIST_ID"
}

Trouvez l’ID d’une liste dans l’application sous Contacts → Listes, via le menu de la ligne de la liste (Copier l’ID de la liste).

Mettre à jour un contact #

PUT https://api.youraiconnector.com/v1/contacts/YOUR_CONTACT_ID?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customFields": { "company": "Acme Inc" }
}

Seuls les champs que vous incluez sont modifiés. C’est également la méthode pour charger en masse des valeurs de champs personnalisés après une importation — consultez Champs personnalisés, profil de prospect et notes. Détails complets dans l’API Contacts.

Envoyer un message (Canal personnalisé) #

POST https://api.youraiconnector.com/v1/send_custom_channel_message?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customData": {
    "fromId": "external-contact-id",
    "customChannel": "my-channel",
    "body": "Hello Jane! Your order has been shipped.",
    "campaignId": "optional-campaign-id",
    "firstName": "Jane",
    "lastName": "Smith"
  }
}

Recevoir des messages entrants (Canal personnalisé) #

Acceptez des messages provenant de systèmes externes en tant que canal personnalisé. C’est ainsi que des intégrations comme GoHighLevel envoient des messages dans Your AI Connector. Consultez les Canaux personnalisés pour plus de détails.

POST https://api.youraiconnector.com/v1/incoming_custom_channel_message?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customData": {
    "messageSid": "unique-message-id",
    "fromId": "external-contact-id",
    "toId": "your-user-id",
    "body": "Customer's message here",
    "channel": "custom",
    "status": "received"
  },
  "messageType": "text"
}

Aperçu des opérations disponibles #

Limitation du débit (Rate Limiting) #

The API enforces rate limits to ensure platform stability. Exceeding your limit returns 429 Too Many Requests — back off and retry after the time indicated in the response headers. For high-volume use cases (bulk imports), use the built-in import feature or email hi@youraiconnector.com for guidance.

Bonnes pratiques #

• Stockez votre clé API en toute sécurité — utilisez un gestionnaire de mots de passe ou une configuration côté serveur, jamais de code côté client qu’un visiteur du navigateur pourrait lire.
• Incluez toujours l’indicatif pays dans les numéros de téléphone (+1 pour les États-Unis, +44 pour le Royaume-Uni, +31 pour les Pays-Bas).
• Gérez les erreurs avec élégance — vérifiez les codes de statut et lisez les messages d’erreur renvoyés.
• Gérez les doublons — un numéro de téléphone en double renvoie { "success": false, "error_code": 409 } au lieu d’un nouveau contact. Recherchez d’abord le contact si vous devez travailler avec lui.
• Testez avec un petit jeu de données avant d’effectuer des opérations en masse.

Réponses d’erreur #

{
  "error": {
    "code": "INVALID_PHONE",
    "message": "Phone number must include a valid country code."
  }
}

Étapes suivantes #

• Webhooks — recevez des notifications en temps réel de l’application (une section distincte de votre clé API).
• Connecter des assistants IA (MCP) — utilisez la même clé API pour laisser Claude piloter votre compte.
• Formulaires de prospects Facebook — utilisez l’API avec des plateformes d’automatisation pour capturer des prospects.
• Intégration GoHighLevel — un exemple complet d’intégration API bidirectionnelle.