Aller au contenu principal

Référence des endpoints

Tous les endpoints ci-dessous utilisent l'URL de base :

https://app.yadulink.com/api/v1

Conventions

Les réponses suivent toujours la même structure :

{
"success": true,
"data": {},
"meta": {}
}

Les erreurs suivent la structure :

{
"success": false,
"error": {
"code": "stable_error_code",
"message": "Message lisible",
"details": {}
}
}

Pagination

Les endpoints de liste utilisent généralement :

ParamètreDéfautMaximumUsage
page1-Page demandée
per_page20 ou 50100Nombre d'éléments par page

Les informations de pagination sont renvoyées dans meta ou dans le payload selon l'endpoint.

Compte

MéthodeEndpointScopeCréditsDescription
GET/meClé API valide0Tester l'authentification
GET/account/statusaccount:read0Lire l'éligibilité API, abonnement et LinkedIn
GET/account/limitsaccount:read0Lire les limites, crédits et budgets d'action
GET/developer/manifestaccount:read0Lire le contrat machine-readable
GET/openapi.jsonPublic selon accès0Lire le schéma OpenAPI

Exemple : statut du compte

curl https://app.yadulink.com/api/v1/account/status \
-H "Authorization: Bearer yd_votre_cle_api"

Crédits

MéthodeEndpointScopeCréditsDescription
GET/credits/balancecredits:read0Lire le solde courant
GET/credits/ledgercredits:read0Lire l'historique des mouvements
GET/credits/packscredits:read0Lister les packs disponibles
POST/credits/quotecredits:read0Estimer le coût d'une opération
POST/credits/packs/{pack_id}/checkoutSession app0Démarrer un checkout Stripe depuis Yadulink

Exemple : lire le solde

curl https://app.yadulink.com/api/v1/credits/balance \
-H "Authorization: Bearer yd_votre_cle_api"

Listes

MéthodeEndpointScopeCréditsIdempotenceDescription
GET/listslists:read0NonLister les listes
POST/listslists:write1OuiCréer une liste
GET/lists/{list_id}lists:read0NonLire une liste
PUT/lists/{list_id}lists:write1OuiModifier une liste
DELETE/lists/{list_id}lists:write1OuiSupprimer une liste
GET/lists/{list_id}/leadsleads:read0NonLister les leads d'une liste

Exemple : créer une liste

curl https://app.yadulink.com/api/v1/lists \
-X POST \
-H "Authorization: Bearer yd_votre_cle_api" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: crm-list-2026-05" \
-d '{
"name": "Prospects mai 2026"
}'

Leads

MéthodeEndpointScopeCréditsIdempotenceDescription
GET/leadsleads:read0NonLister les leads avec filtres
GET/leads/searchleads:read0NonRechercher dans les leads
GET/leads/{lead_id}leads:read0NonLire un lead
POST/leadsleads:write1OuiCréer un lead
PUT/leads/{lead_id}leads:write1OuiModifier un lead
DELETE/leads/{lead_id}leads:write1OuiSupprimer un lead

Exemple : créer un lead

curl https://app.yadulink.com/api/v1/leads \
-X POST \
-H "Authorization: Bearer yd_votre_cle_api" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: crm_123-create-lead" \
-d '{
"list_id": 123,
"full_name": "Ada Lovelace",
"company_name": "Analytical Engines",
"position": "Founder",
"linkedin_url": "https://www.linkedin.com/in/example",
"email": "ada@example.com"
}'

Recherche de leads

curl "https://app.yadulink.com/api/v1/leads/search?q=founder&per_page=25" \
-H "Authorization: Bearer yd_votre_cle_api"

Messages

MéthodeEndpointScopeCréditsDescription
GET/messagesmessages:read0Lister les messages disponibles
GET/messages/{message_id}messages:read0Lire un message

L'envoi de messages LinkedIn se fait via les jobs d'action avec l'opération send_message.

Actions et jobs

MéthodeEndpointScopeCréditsDescription
GET/actionsaccount:read0Lister les actions disponibles
POST/actions/{operation}/jobsjobs:write plus scope actionRéservationCréer un job d'action
GET/jobs/{job_id}jobs:read0Lire l'état d'un job
POST/jobs/{job_id}/canceljobs:write0Annuler un job et rembourser si possible

Opérations disponibles :

OpérationScope actionCoût
profile_visitprofiles:write2 crédits
post_likeposts:write2 crédits
post_commentposts:write8 crédits
send_connection_requestconnections:write10 crédits
send_messagemessages:write10 crédits

Exemple : créer un job de visite de profil

curl https://app.yadulink.com/api/v1/actions/profile_visit/jobs \
-X POST \
-H "Authorization: Bearer yd_votre_cle_api" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: profile-visit-crm_123" \
-d '{
"lead_id": 123
}'

Webhooks

MéthodeEndpointScopeCréditsDescription
GET/webhookswebhooks:manage0Lister les endpoints webhook
GET/webhooks/healthwebhooks:manage0Lire l'état de santé des webhooks
GET/webhooks/{webhook_id}webhooks:manage0Lire un webhook
POST/webhookswebhooks:manage0Créer un webhook
PUT/webhooks/{webhook_id}webhooks:manage0Modifier un webhook
POST/webhooks/{webhook_id}/activatewebhooks:manage0Réactiver un webhook
POST/webhooks/{webhook_id}/deactivatewebhooks:manage0Désactiver un webhook
DELETE/webhooks/{webhook_id}webhooks:manage0Supprimer un webhook
POST/webhooks/{webhook_id}/testwebhooks:manage0Envoyer un événement test
POST/webhooks/{webhook_id}/rotate-secretwebhooks:manage0Tourner le secret de signature
GET/webhooks/{webhook_id}/deliverieswebhooks:manage0Lister les tentatives de livraison
GET/webhooks/{webhook_id}/deliveries/{delivery_id}webhooks:manage0Lire une tentative
POST/webhooks/{webhook_id}/deliveries/{delivery_id}/replaywebhooks:manage0Rejouer une livraison

Endpoints Zapier historiques

Certains endpoints de polling et de souscription Zapier peuvent exister pour compatibilité. Pour un nouveau projet, privilégiez l'API v1 documentée ici ou le connecteur n8n quand votre besoin est orienté workflow.

OpenAPI

Pour obtenir la référence machine-readable :

curl https://app.yadulink.com/api/v1/openapi.json

Le schéma OpenAPI expose les chemins, scopes, paramètres, réponses et métadonnées x-yadulink, notamment les coûts en crédits quand ils existent.