Synup
Créer une clé
v1Ressources/Connexions/getConsulter le statut d'un lien de connexion

Consulter le statut d'un lien de connexion

Indique où en est un lien de connexion. Un lien est considéré comme terminé lorsque le client dispose, sur ce réseau, d'une connexion de marque valide enregistrée après l'ouverture du lien.

get/api/v1/connections/connect-links/{id}
connections:read
Paramètres de requête
idstringobligatoire
L'id du lien de connexion, issu de la réponse de création.
Réponse
dataobjectfacultatif
idstringfacultatif
L'id du lien. Utilisez-le pour consulter le statut ou annuler le lien.
platformstringfacultatif
Le réseau que le lien connecte.
clientIdstringfacultatif
Le client auquel le lien est destiné.
statusstring (pending | started | completed | abandoned | cancelled | expired)facultatif
Où en est le lien : pending (pas encore ouvert), started (ouvert, en attente que la personne termine), completed (le compte est connecté), abandoned (ouvert mais non terminé dans l'heure), cancelled, ou expired (non ouvert avant expiresAt).
expiresAtstringfacultatif
Quand le lien cesse de fonctionner si personne ne l'a ouvert.
startedAtstringfacultatif
Quand le lien a été ouvert, ou null s'il ne l'a pas été.
connectionIdstringfacultatif
La connexion créée par le lien, une fois terminé. Null jusque-là.
reconnectConnectionIdstringfacultatif
La connexion reconnectée, lorsque le lien a été créé pour en reconnecter une. Seule la réponse de création la renvoie ; les consultations de statut renvoient null.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/connect-links/{id}
Votre clé API
id *
{}

Guides qui utilisent cette ressource