Applicable à : Partenaires sportifs et d'intégration
Application : API PlayHQ

Cet article couvrira les points suivants :

1. Comment fonctionne l'intégration du tableau de scores en direct
2. Processus pour les fournisseurs de tableaux de scores pour s'intégrer avec PlayHQ
3. Quels sont les événements webhook de score en direct et leurs déclencheurs
4. Comment fonctionne le filtrage des webhooks
5. Frais PlayHQ pour l'intégration

Articles connexes :

• API de filtre d'entité de webhook
• Événements webhook de jeu en direct - Données d'exemple
• Comment scorer au cricket électroniquement
• Comment utiliser les API PlayHQ

Ressources :

• Documentation technique PlayHQ

Aperçu

En utilisant la solution webhook de jeu en direct de PlayHQ, les partenaires d'intégration (y compris les fournisseurs de tableaux de scores) peuvent afficher les scores des matchs et d'autres informations pertinentes en temps réel, pendant qu'un match est marqué en direct sur le système de score électronique de PlayHQ.

Cet article décrit les événements clés d'un match tels que communiqués par la solution webhook de jeu en direct de PlayHQ et vise à aider les partenaires d'intégration à s'intégrer avec ces webhooks.

Commencer avec l'intégration du tableau de scores en direct

Cette intégration repose sur un partenaire d'intégration qui consomme les événements webhook envoyés à un site spécifié, un lien/URL http. Ces événements seront déclenchés en temps réel capturant les mises à jour pertinentes.

Pour vos besoins de développement et de test, PlayHQ peut vous fournir un accès à un environnement de test approprié. Cela nécessitera que vous fournissiez une URI de test à laquelle nous pourrons envoyer les événements webhook.

Nous pouvons également vous fournir un moyen de définir la portée/filtrer ces événements via l'API afin que vous ne receviez que les webhooks des matchs qui vous intéressent, veuillez consulter la section Utilisation du filtrage de webhook ci-dessous pour plus d'informations.

Pour manifester votre intérêt à devenir partenaire d'intégration, veuillez nous contacter via notre formulaire Ventes & Partenariats sur la page Contactez-nous. 

Événements webhook de score en direct

Les partenaires d'intégration seront abonnés à six événements webhook, documentation liée ci-dessous ;

• Détail du jeu en direct mis à jour - Envoie les mises à jour du tirage au sort et/ou de la composition pendant un match marqué en direct depuis la plateforme de score électronique de PlayHQ. Ce sera toujours le premier événement webhook de jeu en direct et sera également envoyé au début de chaque manche suivante ou chaque fois qu'il y a des changements dans la composition. 
• Feuille de score du jeu en direct - Fournit la feuille de score complète du match et les sélections actuelles des batteurs/lanceurs, pendant un match marqué en direct depuis la plateforme de score électronique de PlayHQ. Le webhook de la feuille de score est déclenché à la fin de chaque over, chaque fois qu'un nouveau batteur ou lanceur est sélectionné, au début/fin/division de chaque manche, chaque fois que des points de pénalité sont appliqués, lorsqu'un joueur est retiré non éliminé et à la suppression d'un événement de score. 
• Événement de score du jeu en direct - Capture des informations sur chaque balle/événement de score ainsi que les scores actuels pour les équipes et joueurs impliqués dans l'événement de score. Par exemple, le batteur 123 a été attrapé par le joueur de champ 456 et voici le score mis à jour du match ainsi que les individus au bâton et au lancer au moment de l'événement. 
• Événement d'annulation du jeu en direct - Ce webhook capture l'annulation ou la suppression d'une balle/événement de score, pendant un match marqué en direct depuis la plateforme de score électronique de PlayHQ. 
• Réinitialisation du jeu en direct - Ce webhook fournit des mises à jour de réinitialisation du match, qui efface le match de tous les scores précédemment capturés et recommence le match depuis le début, pendant le marquage d'un match depuis la plateforme de score électronique de PlayHQ. 
• Webhook de résumé du match - Capture les mises à jour en temps réel avant et après le match, y compris les informations sur les participants et la composition des équipes, les statistiques et le calendrier. Ce webhook ne fournit PAS de mises à jour de score en direct.

Déclenchement des événements webhook

L'événement webhook de résumé du match est généralement déclenché par :

• des mises à jour effectuées par une association aux détails du match (par exemple, attribution du lieu, date, heure) 
• les compositions d'équipe ajoutées par les clubs ou associations avant le match via le Portail Admin ou Mes équipes

Les événements webhook de jeu en direct ne seront déclenchés que pendant le marquage d'un match depuis la plateforme de score électronique de PlayHQ. 

Utilisation du filtrage des webhooks

Un partenaire d'intégration peut souhaiter ne recevoir qu'un sous-ensemble de tous les webhooks. Par exemple ;

• Un opérateur de tableau de scores fixe n'a besoin que des webhooks de jeu en direct pour les matchs joués aux endroits où il exploite un tableau de scores. 
• Un opérateur de tableau de scores mobile n'a besoin que des webhooks de jeu en direct pour les matchs pour lesquels il a organisé le déploiement d'un de ses tableaux de scores mobiles. 

Pour faciliter cela, un abonnement webhook peut être configuré avec un filtre d'entité. Un filtre d'entité est un type d'entité (par exemple, surface de jeu ou match), plus une liste d'ID des entités de ce type. Par exemple; 

• Un opérateur de tableau de scores fixe utiliserait un filtre de type PLAYING_SURFACE, avec une liste d'ID des surfaces de jeu où il a installé des tableaux de scores. Cette liste ne changerait pas très souvent - ajoutant seulement occasionnellement un nouvel ID lorsqu'il installe un nouveau tableau de scores. 
• Un opérateur de tableau de scores mobile utiliserait un filtre de type GAME, avec une liste d'ID des matchs pour lesquels il a organisé le déploiement de ses tableaux de scores. Un opérateur de tableau de scores mobile ajouterait régulièrement de nouveaux ID de matchs à venir à cette liste. 

Un webhook ne sera envoyé à un abonné que s'il passe le filtre d'entité de l'abonné. Par exemple, pour déterminer si l'opérateur de tableau de scores fixe doit recevoir un webhook d'événement de jeu en direct donné, notre répartiteur vérifiera la surface de jeu sur laquelle le match se joue, et n'enverra le webhook que si l'ID de la surface de jeu apparaît dans le filtre PLAYING_SURFACE de l'abonné. De même, l'opérateur de tableau de scores mobile ne recevra un webhook de jeu en direct que si l'ID du match apparaît dans son filtre GAME. 

Configuration

Les filtres, tout comme les abonnés et les abonnements, sont configurés par PlayHQ sur demande. Lorsqu'il est créé pour la première fois, le type d'entité du filtre est défini, mais la liste des ID est vide.

Cela signifie qu'initialement, l'abonné ne recevrait aucun webhook.

Il appartient ensuite au partenaire d'intégration d'utiliser l'API de filtre d'entité de webhook. Plus d'informations sur l'API de filtre d'entité de webhook peuvent être trouvées ici.