Synchroniser les membres et les événements avec des logiciels externes

La Plateforme Yapla est ouverte et permet de créer des communications automatiques avec des logiciels externes via Internet. Différentes techniques permettent de synchroniser des données entres les différents systèmes. Voici la documentation pour ces techniques de synchronisation.

Les méthodes disponibles

APIs - Documentation API pour les membres
Webhooks - Ajouter un webhook pour synchroniser les événements d'une organisation avec un logiciel et Yapla
Zapier - Synchronisez vos membres avec Zapier
Import Excel - Importation manuelle des données dans Yapla à l’aide d’un assistant.
Export Excel - Exportation des données manuellement pour les réintégrer dans un système externe.

API Yapla

Disponible à partir du forfait Plus.

Notre documentation API Membre est à votre disposition pour vous permettre de synchroniser vos membres. Nous vous recommandons d'obtenir l'assistance d'un expert en programmation afin d'y parvenir.

Documentation


openapi: 3.0.0
info:
  description: 
    ## Members
    Vous pourrez obtenir des informations sur vos membres (nom, prénom,
    email, statut, numéro de membre, groupes, etc.) ainsi que sur leurs adhésions (date
    de début, date d'expiration, statut d'adhésion, etc.) pour une campagne donnée.
  version: 1.0.0-oas3
  title: DATA API
  contact:
    name: Support API
    email: support@yapla.com
  termsOfService: https://yapla.ca/en/terms-of-use
servers:
  - url: https://data.s1.yapla.com/api/1.0
    description: "Serveur Amérique du Nord"
  - url: https://data.s2.yapla.com/api/1.0
    description: "Serveur Europe"
paths:
  /campaign/{campaignID}/members:
    get:
      tags:
        - Members
      summary: retourne les membres et leurs adhésions pour une campagne donnée
      operationId: returnMember
      description: 
        En passant les options appropriées, vous pouvez obtenir des informations
        sur les membres et leurs adhésions pour une campagne donnée.
        ### Spécifications de la campagne
        Pour obtenir tous les membres d'une campagne, vous devez indiquer l'ID de la
        campagne.
        Vous pouvez le trouver dans l'URL de la campagne. Pour une campagne en cours,
        veuillez entrer 0.
        ### Spécifications du token
        La clé API sera disponible dans le compte Yapla sous Configuration / API.
        ### Spécifications de la pagination
        Par défaut, l'API est paginée, donc n'oubliez pas d'indiquer le numéro
        de la page souhaitée ainsi que le nombre de résultats par page.
        Le nombre total de résultats n'est pas indiqué, vous devez donc itérer jusqu'à
        obtenir une page vide. Les résultats sont listés du plus récent au plus ancien.
        Si un membre est ajouté pendant l'appel, il sera ajouté à la page 1.
      parameters:
        - in: path
          name: campaignID
          description: si la campagne est en cours, mettre 0. Sinon, 
indiquer l'ID de la campagne
          required: true
          schema:
            type: integer
            minimum: 0
        - in: query
          name: token
          description: insérer la clé API de votre compte Yapla
          required: true
          schema:
            type: string
        - in: query
          name: page
          description: indiquer le numéro de la page souhaitée
          required: true
          schema:
            type: integer
            minimum: 1
        - in: query
          name: locale
          description: langue des réponses (fr ou en)
          schema:
            type: string
        - in: query
          name: per_page
          description: définir le nombre de résultats par page
          required: true
          schema:
            type: integer
            minimum: 1
        - in: query
          name: email
          description: filtrer par adresse email d'un membre
          schema:
            type: string
      responses:
        '200':
          description: résultats correspondant aux critères de recherche
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberResponse'
        '400':
          description: paramètre d'entrée incorrect
components:
  schemas:
    MemberResponse:
      type: object
      properties:
        id:
          type: string
          description: L'ID du membre.
          example: natBqZ8Ud5l5sdgAdlkNKVud
        numero_de_membre:
          type: string
          description: Le numéro du membre.
          example: '0004317'
        firstname:
          type: string
          description: Le prénom du membre.
          example: John
        lastname:
          type: string
          description: Le nom du membre.
          example: Doe
        email:
          type: string
          description: L'adresse email du membre.
          example: emailMember@hiscompany.com
        member_language:
          type: string
          description: Langue du membre.
          example: French
        statut:
          type: string
          description: Statut du membre (actif/inactif).
          example: active
        adhesion_name:
          type: string
          description: Nom du type d'adhésion.
          example: VIP membership
        adhesion_statut:
          type: string
          description: Statut de l'adhésion.
          example: validate
        adhesion_subscription_date:
          type: string
          description: Date de souscription.
          example: '2018-01-01'
        adhesion_date_debut:
          type: string
          description: Date de début de l'adhésion.
          example: '2018-01-01'
        adhesion_date_renouvellement:
          type: string
          description: Date de renouvellement de l'adhésion.
          example: '2018-12-31'
        adhesion_type:
          type: string
          description: Type de traitement de l'adhésion (première adhésion uniquement/renouvellement uniquement).
          example: Renewal only
        adhesion_identifiant:
          type: string
          description: Numéro d'adhésion.
          example: ADH-003
        Community:
          $ref: '#/components/schemas/Community'
        content-hash:
          type: string
          description: Code hash pour l'objet actuel.
          example: -
            2c1665e2197c6d0f9e9ec9ac3de9cd7a5f4b8f1f56757015f44a5e77d0ec5638b095f0af68
            57c339f06478ac860d5b0c653787027da184fa6b4aca717bd01542
    Community:
      description: "Correspond aux groupes auxquels appartient le membre. Cela inclut les groupes système Yapla et les groupes personnalisés."
      properties:
        id:
          type: string
          description: L'ID du groupe.
          example: '28222'
        name:
          type: string
          description: Le nom du groupe.
          example: Active member

Pour plus de détails, consultez les articles suivants :

Webhooks

Un webhook est une fonction de rappel HTTP, définie par un utilisateur de Yapla, qui récupère des données à partir d'un événement. Par exemple, il est possible de configurer un webhook dans Yapla qui effectue un appel HTTP vers un système externe chaque fois qu'un dossier de membre est modifié. Les webhooks sont diposnibles pour les événements et les dons.

Le serveur appelé, via une URL, reçoit une structure JSON contenant toutes les informations associées à l'événement. Les appels peuvent être sécuri

Import Excel

Pour les synchronisations occasionnelles, nous offrons un système d’import manuel qui permet de synchroniser les membres, les organisations et les adhésions.

Cette technique est habituellement utilisée lors de la configuration initiale de la plateforme.

Export Excel

En tout temps, il est possible d’exporter l’ensemble des données des membres d’un compte Yapla. Cliquez sur Exporter dans l'onglet Membres.

Recevoir des données externes vers Yapla

La meilleure façon de synchroniser les membres d’un système existant avec Yapla est d’adopter l’approche suivante: une première synchronisation manuelle qui reprend tous les membres à un moment précis pour les remonter dans Yapla. Suite à cette première étape, le système externe doit utiliser l’API de Yapla pour envoyer les données d’un membre précis pour chaque création ou mise à jour. Ainsi, Yapla a toujours les dernières données du système externe.

Envoyer des données vers un système externe

Le principe est le même :

la première étape consiste à intégrer les membres existants dans le système externe via une exportation Excel.
Après cette première étape, il vous suffit de configurer un webhook dans Yapla qui appellera le système externe lors des deux événements suivants : "Créer un membre" et "Modifier un membre".

Synchronisation bi-directionnelle

Il n'est pas possible de maintenir Yapla et un système externe synchronisé en tout temps. Les fonctions de synchronisation de Yapla ne permettent que la lecture. Aucun service n'est disponible pour mettre à jour les données dans Yapla via un API.

Pour toutes questions sur le sujet, communiquer avec support@yapla.com.