API publique
      Revenir à l'accueil
      1. Help Center
      2. Intégrations
      3. API publique

      Utiliser l'API JeudiMerci

      Vous souhaitez envoyer de façon automatisée des cadeaux à des destinataires remplissant certains critères ? C'est possible grâce à notre API !

      Documentation de l'API

      La documentation de l'API se trouve dans la section "Automatisation" de votre espace JeudiMerci.

      POST: déclencher l'envoi d'un cadeau

      Cette requête vous permet de passer une commande et retourne une réponse indiquant la bonne exécution, ainsi que l'ID de la commande créée.

      Vos identifiants

      Pour envoyer une requête, vous devez vous identifier:

      • Identifier votre entreprise grâce à votre companyId.
      • Identifier l'utilisateur qui passe la commande grâce à votre userId. Cet UserID est important pour vous offrir une visibilité claire sur les cadeaux envoyés par chaque membre de l'équipe.

      Le destinataire

      Vous devez ensuite indiquer des informations sur le destinataire:

      deliveryAddress: l'adresse de livraison du cadeau.
      Ce champs est optionnel - si vous choisissez l'option "DeliveryWithoutAddress", nous n'avons pas besoin de connaître l'adresse de livraison à priori.

      Le cadeau

      • giftId : c'est la référence du cadeau que vous souhaitez envoyer.
        Celle-ci est disponible dans la description de chaque cadeau, dans votre catalogue.

      • quantity: c'est le nombre de cadeaux que vous souhaitez envoyer. Comme il est rare d'envoyer plusieurs fois le même cadeau à un seul destinataire, le champ n'est pas obligatoire et automatiquement considéré comme valant 1.

      Options de livraison

        • Livraison sans adresse
          Vous ne connaissez pas l'adresse de livraison ? Choisissez optionsDeliveryWithoutAddress: un email sera envoyé automatiquement au destinataire pour qu'il/elle choisisse où se faire livrer.

          Ce champ comporte 3 options :
          • deliveryWithoutAddress : précise si cette option est sélectionnée ou non. Ce champ est obligatoire.
          • emailAlibiExpeditor : le nom de la personne qui offre le cadeau. Ce champ n'est pas obligatoire mais vivement conseillé ; il donne du contexte à votre destinataire, et l'incite à donner son adresse. 
          • emailAlibiContent : une petite phrase expliquant POURQUOI vous envoyez ce cadeau. Ce champ n'est pas obligatoire mais vivement conseillé : il donne du contexte à votre destinataire, et l'incite à donner son adresse. 
        • Confirmation d'adresse
          Vous avez une adresse postale, mais n'êtes pas sûr·e que ce soit la bonne ? Laissez à votre destinataire la possibilité de la modifier ! Choisissez optionsAddressConfirmation, et nous contactons le destinataire par mail afin qu'il puisse confirmer ou modifier son adresse de livraison.

          Ce champ comporte quatre informations :
          • confirmation : précise si cette option est séléctionnée ou non. Ce champ est obligatoire.
          • emailAlibiExpeditor : le nom de la personne qui offre le cadeau. Ce champ n'est pas obligatoire mais vivement conseillé: il donne du contexte à votre destinataire, et l'incite à donner son adresse. 
          • emailAlibiContent :
          • une petite phrase expliquant POURQUOI vous envoyez ce cadeau. Ce champ n'est pas obligatoire mais vivement conseillé: il donne du contexte à votre destinataire, et l'incite à donner son adresse. 
          • sendAnyway : Ce champ indique si la commande doit être envoyée si le destinataire n'a pas confirmé son adresse dans le délai imparti. Si l'option de confirmation d'adresse est sélectionnée, ce champ est obligatoire.

      Confirmation de commande

      Le champs optionsEmailConfirmation vous permet de choisir si un email de confirmation doit être envoyé à votre équipe à chaque fois qu'un cadeau est commandé. Ce champ n'est pas obligatoire et vaut faux par défaut.

       

      Vous ne trouvez pas de réponses à vos questions ? Ecrivez nous sur support@jeudimerci.fr.