API développeurs

Un message privé en un seul POST.

Une API REST pour votre CRM, incluse dans l’offre Business : contacts, conversations, affaires, tâches, séquences et messages sur Telegram, X et la boîte de réception sociale. Authentification Bearer, clés à portée limitée, idempotence, en-têtes de limite de débit et webhooks sortants. Aucun SDK nécessaire.

  • JSON sur HTTPS
  • Réponses à faible latence
  • Fiable par conception

Dernière mise à jour:

Choisissez votre stack

Un seul endpoint. Quatre langages.

Un seul contrat JSON. Copiez, collez, mettez en production. La spécification OpenAPI complète décrit chaque endpoint, chaque erreur et chaque payload de webhook.

curl -X POST https://api.pinlyx.com/v1/telegram/messages \  -H "Authorization: Bearer csk_live_***" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"accountId":7421,"username":"sarah_miller","text":"Bienvenue à bord"}'

Référence complète et catalogue des erreurs sur docs.pinlyx.com/api

Authentification

Des clés à portée limitée. Le moindre privilège par défaut.

Générez des clés API à portée limitée : lecture seule pour les tableaux de bord analytiques, écriture pour les envois en production, gestion pour l’automatisation des opérations. Faites-les tourner sans interruption : l’ancienne et la nouvelle clé coexistent pendant la bascule, rien ne casse.

  • Authentification Bearer

    Transmettez Authorization: Bearer csk_live_… à chaque requête. Les clés de production et de test se distinguent au premier coup d’œil, pour garder vos flux de production à l’abri.

  • Permissions par portée

    Choisissez le plus petit ensemble de portées dont une clé a besoin. Une clé de tableau de bord qui fuite ne pourra jamais envoyer de message.

  • Rotation sans interruption

    Émettez une clé de remplacement, déployez, puis révoquez l’ancienne. Les deux restent valides pendant la période de chevauchement : pas d’avalanche d’erreurs 401.

Envoi en productionProduction
csk_live_a4f9_
Portées
  • contacts:readLister, rechercher et lire les contacts et leurs conversations.
  • telegram:readVérifier le statut d’un message Telegram en file d’attente.
  • analytics:readRécupérer les statistiques d’entonnoir, de séquences et de comptes.
  • telegram:sendMettre en file des messages Telegram depuis vos propres comptes.
  • contacts:writeCréer, modifier et étiqueter des contacts.
  • sequences:writeInscrire des contacts dans des séquences, les mettre en pause et les relancer.
  • webhooks:writeEnregistrer et remplacer des endpoints de webhook.
Fiabilité

Une contre-pression qui vous dit tout.

Grâce aux clés d’idempotence, les nouvelles tentatives sont sans risque : le même message ne part jamais deux fois. Les en-têtes de limite de débit indiquent à votre client quand ralentir, bien avant la moindre erreur 429.

Réponse · 200 OK187 ms
X-RateLimit-Limit
60
# requêtes par minute, par clé
X-RateLimit-Remaining
48
# restantes dans la fenêtre en cours
X-RateLimit-Reset
1778077380
# heure Unix de réinitialisation de la fenêtre
Retry-After
12
# en cas de 429, secondes à attendre
  • Clés d’idempotence

    Transmettez Idempotency-Key à chaque écriture. Une nouvelle tentative avec la même clé dans les 24 heures renvoie la réponse d’origine au lieu d’envoyer à nouveau.

  • Limites de débit par clé

    Chaque clé API autorise par défaut 60 requêtes par minute, un plafond réglable clé par clé. Les envois Telegram suivent ensuite le rythme propre au compte : par défaut 20 messages par heure et 10 secondes d’intervalle, avec une temporisation automatique en cas de flood wait.

  • Catalogue d’erreurs stable

    Chaque erreur renvoie un Error stable sur lequel brancher votre logique, ainsi qu’un Message lisible à afficher, avec la même structure JSON sur tous les endpoints.

Webhooks

Des webhooks sortants pour chaque événement.

Recevez 31 événements CRM en temps réel. Signatures HMAC-SHA256, nouvelles tentatives automatiques avec délai exponentiel et un journal des livraisons où vous pouvez relancer n’importe quel envoi.

Autres événements
  • message.sent
  • contact.created
  • pipeline.stage_changed
  • sequence.completed
  • outreach.replied
  • task.completed
  • support.ticket.created
  • subscription.changed
POSTyour-handlerlivré
{  "event": "message.received",  "id": "8c1f4b9e2d7a4c03b5e6f1a2",  "deliveredAt": "2026-05-06T14:32:18Z",    "channel": "telegram",    "contactId": 8821,    "counterparty": "@sarah_miller",    "text": "Bonjour, pouvez-vous m’envoyer la démo ?"}
Vérifier à la réceptionNode.js
const sig = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');if ('sha256=' + sig !== headers['x-webhook-signature']) return 401;

Quand vous voulez

Développez avec Pinlyx. En production en quelques minutes.

Avec l’offre Business, créez une clé dans le panneau, collez une commande curl et regardez le message rejoindre la file d’attente. La référence OpenAPI documente chaque endpoint et chaque erreur.

  • Inclus dans l’offre Business
  • Clés créées dans le panneau
  • Webhooks signés HMAC