Intégration API pour Business

Une partie importante de l’intégration du Business Plan ou du Launch Plan consiste à créer de nouveaux comptes de profil dans Ayrshare pour vos utilisateurs ou clients et à permettre à vos utilisateurs de lier leurs réseaux sociaux via la page de liaison sociale. Chacun de vos utilisateurs est configuré comme un profil utilisateur Ayrshare. Un profil utilisateur obtient une connexion à chaque réseau social.

C’est la méthode standard pour intégrer les clients. Vos utilisateurs connectent leurs propres comptes sociaux via la page de connexion via URL JWT en marque blanche décrite ci-dessous — ils ne se connectent jamais à Ayrshare et ne touchent jamais à votre tableau de bord. Le tableau de bord est réservé à votre équipe interne (création et gestion des profils, tests et publication au nom d’un client).

Flux d’intégration

Pour intégrer Ayrshare dans votre application, vous devrez effectuer deux appels API :

Appelez le point de terminaison Create Profiles pour créer un nouveau profil Ayrshare pour votre utilisateur.
Appelez le point de terminaison Generate JWT pour obtenir une URL JWT.

L’URL JWT permet à votre utilisateur d’accéder en toute sécurité à la page de liaison sociale via l’authentification unique. Vous afficherez cette page dans un nouvel onglet, une nouvelle fenêtre ou un contrôleur de vue pour permettre aux utilisateurs de connecter leurs comptes de réseaux sociaux.

Une fois que votre utilisateur aura lié ses comptes de réseaux sociaux, vous pourrez publier des publications, obtenir des statistiques et gérer ses comptes via l’API.

Pour des raisons de sécurité, les plateformes de réseaux sociaux exigent que les utilisateurs s’authentifient via leur navigateur, ce qui ne peut pas être fait via des appels de serveur backend. Cela garantit que vos utilisateurs peuvent connecter en toute sécurité leurs comptes de réseaux sociaux en se connectant directement avec la page de connexion officielle de chaque plateforme. Les réseaux sociaux limitent l’authentification à leurs domaines partenaires autorisés uniquement, tels qu’Ayrshare. Ils bloquent également les iFrames, ce qui signifie que vous ne pouvez pas intégrer ou afficher la page de liaison Ayrshare dans un iFrame sur votre site.

Créer un profil utilisateur Ayrshare

Créer un profil avec l’API

Lorsqu’un nouvel utilisateur s’inscrit dans votre système ou lorsque votre client clique sur le lien de réseau social dans votre application, créez un nouveau compte de profil Ayrshare en appelant le point de terminaison RESTful /profiles/create-profile, ou en utilisant les packages NPM ou PyPi.

Profils

Cet appel renverra la PROFILE KEY de votre utilisateur. Cette clé sera utilisée pour publier au nom de votre utilisateur et pour gérer son compte. Vous devez la stocker dans un emplacement sécurisé.

Créer un profil avec le tableau de bord (équipe interne)

Votre équipe interne peut également créer des User Profiles directement depuis le Developer Dashboard — utile pour les tests, l’intégration manuelle d’un profil ou une administration ponctuelle. Il s’agit d’un outil pour l’équipe, et non d’un flux orienté client : vos clients n’ont jamais accès au tableau de bord et sont toujours intégrés via la page de connexion via URL JWT. Pour l’intégration en production, créez les profils par programmation avec l’API afin que chaque nouvel utilisateur soit provisionné automatiquement.

Gérer les User Profiles dans le tableau de bord

Package d’intégration

Lors de votre onboarding en tant que client Business Plan ou Launch Plan, vous avez reçu un package d’intégration personnalisé avec des informations importantes de configuration et de domaine, des exemples d’appels de points de terminaison, et plus encore. Veuillez vérifier auprès de votre titulaire de compte principal pour ces informations. Vous pouvez également récupérer ou réinitialiser le package d’intégration dans le tableau de bord dans la page API. Assurez-vous d’abord de passer à votre Primary Profile.

Authentification unique avec JWT

Ayrshare utilise un JWT (JSON Web Token) pour authentifier votre utilisateur et effectuer l’authentification unique sur la page de liaison sociale. Un JWT est un mécanisme sécurisé pour transmettre des informations numériquement signées et permet à Ayrshare de vous authentifier, vous et votre utilisateur.

Générer un JWT

Votre application construira un JWT composé de votre API Key, de la Profile Key de l’utilisateur et de quelques autres paramètres. Celui-ci sera signé avec votre clé privée de 1024 bits.

Le token JWT est valide pendant 5 minutes. Veuillez consulter le Max Pack pour un temps d’expiration plus long.

Veuillez utiliser le point de terminaison Generate JWT pour qu’Ayrshare crée le token et l’URL de liaison sociale. Ouvrez l’URL de liaison sociale dans un nouvel onglet ou une nouvelle fenêtre, permettant à vos utilisateurs de lier facilement leurs réseaux sociaux.

L’URL JWT est la voie d’intégration recommandée pour chaque client. Vos utilisateurs s’authentifient directement avec chaque réseau social par eux-mêmes — vous ne collectez ni ne stockez jamais leurs identifiants sociaux. Si votre équipe a besoin de lier un compte manuellement pendant les tests, elle peut le faire depuis le tableau de bord, mais il s’agit d’une commodité interne et non de la façon dont les clients devraient être intégrés.

Marque blanche de la page Connect Accounts

Comme la page de connexion ouverte par l’URL JWT est la seule interface Ayrshare que vos utilisateurs voient, vous devez la personnaliser à votre marque. Ajoutez votre logo et vos en-têtes personnalisés, choisissez quels réseaux sociaux apparaissent, définissez la langue de la page et utilisez vos propres liens d’aide — et avec le Max Pack, appliquez un fichier CSS entièrement personnalisé, une favicon, un titre de page et un pied de page. Ces options sont configurées une seule fois par votre équipe depuis le Primary Profile et s’appliquent à chaque URL JWT que vous générez.

Marque blanche de la page Connect Accounts

Découvrez toutes les options de branding et de personnalisation pour la page de connexion.

Déconnexion automatique d’une session de profil

Comment se déconnecter automatiquement de la session de profil activeSi un profil est déjà connecté, envoyer le JWT d’un profil différent ne changera pas de profil. Cela est fait pour rendre l’expérience plus rapide pour les utilisateurs déjà connectés. Lors des tests, déconnectez-vous du profil actuel avant d’effectuer un appel SSO avec un profil différent. Les profils connectés restent connectés jusqu’à ce qu’ils soient explicitement déconnectés.Cependant, si vous avez un besoin métier, tel que vos utilisateurs ayant plusieurs profils auxquels ils accèdent souvent, ou si vous souhaitez tester, incluez le paramètre d’URL dans l’URL SSO :logout=truePar exemple :https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&logout=trueCela force une déconnexion puis connecte le nouveau profil.Veuillez également consulter le point de terminaison Generate JWT pour ajouter automatiquement la déconnexion.Attention : L’utilisation de la déconnexion automatique entraîne un délai de performance pour votre utilisateur, donc à moins que vous en ayez besoin, nous suggérons de ne pas forcer une déconnexion et de ne pas l’utiliser en production.

Ouverture et fermeture de l’URL de liaison sociale

La page Social Accounts dispose d’un bouton « Close » qui ferme la fenêtre et renvoie votre utilisateur sur votre site.

Ouverture de l’URL de liaison sociale

Lorsque vous ouvrez l’URL de liaison sociale, nous recommandons d’utiliser la fonction window.open() de JavaScript plutôt qu’un href d’ancrage. Le bouton « Close » utilise JavaScript pour fermer la fenêtre, et la plupart des navigateurs n’autorisent que les fenêtres ouvertes via un script à être fermées. Vous pouvez utiliser l’exemple de code suivant sur votre site web pour lancer la fenêtre de liaison sociale.

Window Open

<div onclick="window.open('https://profile.ayrshare.com?domain...', '_blank')">
  Link Social Networks
</div>

Window Open Function

<button onclick="openNewTabAndRedirect()">Open New Tab and Redirect</button>
<script>
  function openNewTabAndRedirect() {
    // Open a new tab
    var newTab = window.open("https://profile.ayrshare.com?domain...");

    // Optional: Focus on the new tab
    newTab.focus();
  }
</script>

Vous pouvez contrôler le bouton « Close » pour rediriger soit l’onglet de liaison sociale vers une page de votre choix, soit rediriger l’onglet/la fenêtre d’origine et fermer l’onglet de liaison sociale. Cela peut être fait en utilisant le paramètre redirect et en ajoutant origin=true aux paramètres de requête de l’URL de redirection. Veuillez consulter le point de terminaison Generate JWT pour plus de détails.

Redirection lors de la fermeture

De plus, si vous souhaitez que le bouton Close redirige vers votre page (souvent utile sur mobile), passez le paramètre GET redirect en tant que chaîne URL encodée commençant par https. Veuillez consulter les paramètres du point de terminaison Generate JWT pour plus de détails.

JWT URL

https://profile.ayrshare.com?domain=[domain id]&jwt=[jwt token]&redirect=https%3A%2F%2Fmywebsite.com

La redirection sera enregistrée pour ce profil et utilisée dans les appels SSO ultérieurs même si le paramètre redirect n’est pas passé. Pour réinitialiser le bouton Close à la fermeture, passez le paramètre redirect=null.

Plus d’informations

Notifications de liaison ou de déliaison utilisateur

Lorsqu’un utilisateur lie ou délie un réseau social, vous pouvez recevoir une notification via webhook. Veuillez consulter la page Social Action Webhooks pour plus d’informations. Vous pouvez également utiliser le point de terminaison user pour obtenir les réseaux sociaux connectés d’un profil utilisateur.

Plusieurs ensembles de comptes sociaux

Aperçu

Chaque User Profile dispose d’un ensemble de comptes de réseaux sociaux et peut établir une connexion à chaque réseau social. Si vos utilisateurs ou clients ont plusieurs ensembles de comptes de réseaux sociaux, tels que deux Facebook Pages, deux comptes Instagram et deux chaînes YouTube, vous pouvez gérer ces multiples ensembles de comptes de réseaux sociaux en suivant ces étapes :

Créer plusieurs User Profiles - Créez des User Profiles distincts au sein du système Ayrshare pour chaque ensemble de comptes sociaux que votre utilisateur ou client doit gérer.
Stocker des Profile Keys uniques - Chaque User Profile aura sa propre Profile Key unique, renvoyée par le point de terminaison de création de User Profile.
Étiquetez vos profils - Attribuez un titre ou tag à chaque User Profile pour identifier clairement les comptes de réseaux sociaux auxquels ils sont associés (par exemple, « Facebook Page A » et « Facebook Page B »).
Mappez dans votre base de données - Dans votre propre système, associez toutes les Profile Keys pertinentes à l’utilisateur ou au client concerné.
Utilisez la Profile Key appropriée - Lors de la publication de contenu ou de la récupération de statistiques pour un compte social spécifique, utilisez la Profile Key associée à ce compte. Par exemple, pour publier sur Facebook Page A, utilisez la Profile Key du User Profile connecté à Facebook Page A.

Exemple

Considérons un scénario pratique pour plusieurs comptes clients :

Client : La chaîne de restaurants de Joe avec deux emplacements

Joe a besoin de comptes de réseaux sociaux distincts pour chaque emplacement de restaurant : Emplacement 1 du restaurant :

Facebook Page : « Joe’s Downtown Bistro »
Instagram : @joesdowntownbistro
LinkedIn : page business Joe’s Downtown Bistro

Emplacement 2 du restaurant :

Facebook Page : « Joe’s Seaside Grill »
Instagram : @joesseasidegrill
LinkedIn : page business Joe’s Seaside Grill

Solution d’implémentation :

Créez deux User Profiles distincts dans Ayrshare :

User Profile 1 : intitulé « Joe’s Downtown Bistro Accounts »
User Profile 2 : intitulé « Joe’s Seaside Grill Accounts »

Connectez les comptes sociaux appropriés à chaque profil :

Profil 1 : Lie les comptes Facebook, Instagram et LinkedIn de Downtown Bistro
Profil 2 : Lie les comptes Facebook, Instagram et LinkedIn de Seaside Grill

Stockez les deux Profile Keys dans votre base de données, en les associant au compte de Joe :

Client: Joe's Restaurant Chain
- Profile Key 1: abc123... (Downtown location)
- Profile Key 2: xyz789... (Seaside location)

Lors de la publication d’une mise à jour de menu spéciale pour l’emplacement Downtown, utilisez Profile Key 1 dans les appels API. Lors de la publication d’une promotion de fruits de mer à l’emplacement Seaside, utilisez Profile Key 2.

En créant plusieurs User Profiles, en leur attribuant un titre ou un tag approprié, et en les associant à un seul utilisateur ou client dans votre système, vous pouvez gérer leurs multiples comptes de réseaux sociaux sur les mêmes plateformes à l’aide d’Ayrshare. Cette approche permet une publication ciblée et une récupération de statistiques pour chaque compte spécifique.

Étapes suivantes

Veuillez consulter ici pour plus de détails sur l’expérience utilisateur :

Intégration utilisateur

Une fois que votre utilisateur aura configuré ses liens de réseaux sociaux, vous pourrez commencer à publier en son nom en utilisant les points de terminaison /post et /profile.

Flux d’intégration

Créer un profil utilisateur Ayrshare

Créer un profil avec l’API

Profils

Créer un profil avec le tableau de bord (équipe interne)

Gérer les User Profiles dans le tableau de bord

Package d’intégration

Authentification unique avec JWT

Générer un JWT

Marque blanche de la page Connect Accounts

Marque blanche de la page Connect Accounts

Déconnexion automatique d’une session de profil

Ouverture et fermeture de l’URL de liaison sociale

Ouverture de l’URL de liaison sociale

Redirection lors de la fermeture

Plus d’informations

Notifications de liaison ou de déliaison utilisateur

Plusieurs ensembles de comptes sociaux

Aperçu

Exemple

Étapes suivantes

Intégration utilisateur

Post API

Profiles API

​Flux d’intégration

​Créer un profil utilisateur Ayrshare

​Créer un profil avec l’API

Profils

​Créer un profil avec le tableau de bord (équipe interne)

Gérer les User Profiles dans le tableau de bord

​Package d’intégration

​Authentification unique avec JWT

​Générer un JWT

​Marque blanche de la page Connect Accounts

Marque blanche de la page Connect Accounts

​Déconnexion automatique d’une session de profil

​Ouverture et fermeture de l’URL de liaison sociale

​Ouverture de l’URL de liaison sociale

​Redirection lors de la fermeture

​Plus d’informations

​Notifications de liaison ou de déliaison utilisateur

​Plusieurs ensembles de comptes sociaux

​Aperçu

​Exemple

​Étapes suivantes

Intégration utilisateur

Post API

Profiles API

Flux d’intégration

Créer un profil utilisateur Ayrshare

Créer un profil avec l’API

Créer un profil avec le tableau de bord (équipe interne)

Package d’intégration

Authentification unique avec JWT

Générer un JWT

Marque blanche de la page Connect Accounts

Déconnexion automatique d’une session de profil

Ouverture et fermeture de l’URL de liaison sociale

Ouverture de l’URL de liaison sociale

Redirection lors de la fermeture

Plus d’informations

Notifications de liaison ou de déliaison utilisateur

Plusieurs ensembles de comptes sociaux

Aperçu

Exemple

Étapes suivantes