Skip to content

Home

Jump to bottom
abelin-tbs edited this page Feb 5, 2021 · 15 revisions

Présentation

L'api REST mahalo vous permettra de communiquer avec l'outil de gestion des abonnements Mahalo : https://mahalo.tbsblue.com

Elle vous permettra notamment dans le cadre d'une boutique en ligne :

  • De lire le référentiel des Offres Mahalo
  • De créer et modifier les informations de vos contacts
  • De lire les informations d'un contact (abonnements, factures)
  • D'enregistrer et de valider une commande WEB

Comment commencer ?

  1. La première étape est la connexion au backend Mahalo
  2. Chaque API peut-être valider individuellement via OPENAPI :
  3. Grâce au repository https://github.com/GitMahalo/mahalo-php-v3, vous trouverez des exemples PHP fonctionnels
  4. Grâce à ce wiki, vous aurez accès à plus d'information fonctionnel et à des astuces, enchainements d'appels, bref à une information organisée et thématique

Connexion au backend Mahalo

TODO

Dossier 'Commande'

Partie donnant différents exemples pour la création d'une commande pour un contact.

Une fois la commande passée, il n'est pas possible de la modifier par WS.

Le paramètre : nePasModifierClient

  • 0 : écrase les données client lors de la validation de la commande. Il faut bien remettre toutes les données du client car celles absentes seront supprimées dans ce cas.
  • 1 : ne pas écraser les données client lors de la validation de la commande

commandeAboAdresseLiv.php : exemple d'une commande avec différents abonnements et différents types d'adresse de livraison typeAdresseLiv : paramètre qui va gérer l'adresse de livraison en fonction de sa valeur

  • 0 : adresse de livraison du 'codeClient'
  • 2 : nouvelle adresse de livraison avec création d'un nouveau client. Il faut ajouter les paramètres : civiliteLiv, nomLiv, prenomLiv, adresse2Liv, cpLiv, villeLiv, codeIsoPaysLiv (Obligatoire).
  • 5 : nouvelle adresse temporaire de livraison sans création d'un nouveau client. Il faut ajouter les paramètres : civiliteLiv, nomLiv, prenomLiv, adresse2Liv, cpLiv, villeLiv, codeIsoPaysLiv (Obligatoire).
  • 7 : adresse de livraison du beneficiaire identifie par le 'codeClientLiv'. Il faut ajouter le paramètre : codeClientLiv (Obligatoire).

modePaiement : paramètre qui va gérer le mode de paiement de la commande

  • 1 : paiement par chèque
  • 2 : paiement CB One shot (cf commandeSimpleMultiOneShot.php)
  • 3 : paiement par prélèvement SEPA / RIB (creation de Mandat necessaire en amont) ce mode de paiement est lié à la clé système ‘CREATE_REGLEMENT_FOR_RIB_COMMANDE’. (cf commandeAboAvecMandatSepa.php)
  • 4 : paiement par virement
  • 5 : paiement Paypal
  • 6 : paiement par prélèvement CB (création de la CB necessaire en amont) (cf commandeAboADLStripe.php)

commandeAboAvecPns.php : exemple pour forcer le Premier Numéro à Servir (pns) lors d'un abonnement ou d'un réabonnement pns : paramètre à ajouter sur la commande Si la clé système 'COMMANDES_FIND_ABONNEMENTS_ECHUS' vaut True alors on ne tient pas compte du pns car il est calculé tout seul coté Aboweb et il n'y a pas besoin d'ajouter la paramètre refAboEchu (paramètre qui permet de donner la référence de l'abonnement à réabonner cf commandePourReabo.php). La clé système : 'WS_FORCE_DEBUT_ABO', permet de forcer le pns pour un abonnement quand 'COMMANDES_FIND_ABONNEMENTS_ECHUS' vaut False. La clé système : 'WS_REABO_FORCE_PNS', permet de forcer le pns pour un réabonnement sur un tarif simple (ne fonctionne pas sur une formule)

commandeAboALDirectAvecCS.php : exemple de commande avec des Codes de Sélection (CS) refCs : référence du parametre CS obtenu par l'api aidesaisie Il est possible d'ajouter un CS sur un client, une facture, une ligne de facture ou un abonnement.

Clone this wiki locally