API : Création du client

SELL&SIGN associe les signataires et les transactions à une tierce partie, appelée Client (Customer).

Pour créer ou mettre à jour un client, on peut utiliser la méthode selectOrCreateCustomer de la classe Customer. Le champ « number » est la clé unique pour désigner un client. Nous ne proposons aucun mécanisme pour sa génération. Si la clé soumise existe déjà, alors le client correspondant sera mis à jour en fonction des données reçues. Dans tous les cas, la fonction retourne les données finales du client.

Une façon rapide d’appeler cette méthode est d’utiliser l’API REST sous la forme d’un HTTP GET (le mieux étant d’utiliser un HTTP POST) :

http://[host]/calinda/hub/selling/model/customer/update?action=selectOrCreateCustomer&[paramètres]
  • Paramètres obligatoires :

    • number : numéro unique de client nouveau ou existant
    • civility : civilité du contact (valeurs possibles : MONSIEUR, MADAME, MADEMOISELLE)
    • firstname : prénom du contact
    • lastname : nom du contact
    • email : email du contact
    • cell_phone : téléphone mobile du contact
    • address_1 : adresse partie 1
    • postal_code : code postal
    • city : ville
    • country : pays (ISO 3166 alpha-2 country code ou UN M.49 numeric-3 area code)
    • customer_code : votre code client mnémonique
  • Paramètres facultatifs : 
    (doivent figurer dans la requête en mode http get mais acceptent une valeur vide)

    • company_name : société
    • registration_number : SIRET de la société
    • address_2 : adresse partie 2
    • phone : téléphone du contact
    • job_title : fonction du contact
    • birthdate : date de naissance du contact
    • birthplace : lieu de naissance du contact

Attention : pour passer des éléments en URL, ils doivent être URLencodés. Par exemple, la chaîne sales@calindasoftware.com
devient sales%40calindasoftware.com. Si besoin, vous trouverez ici un service en ligne permettant d’URLencoder une chaîne de caractères.

Exemple :

https://cloud.sellandsign.com/calinda/hub/selling/model/customer/update?action=selectOrCreateCustomer&number=AM201603021055&customer_code=SIRET123&company_name=CUSTOMER&registration_number=SIRET123&address_1=A&address_2=B&postal_code=13100&city=PARIS&country=FR&civility=MONSIEUR&firstname=Bernard&lastname=Sanders&email=test%40calinda.fr&cell_phone=01234567890&phone=01234567890&job_title=Director&birthdate=&birthplace=&j_token=[votre token d'authentification]

Retour :

{"number":"AM201603021055",
"actorId":141,
"syncTimer":1456913816030,
"civility":"MONSIEUR",
"firstname":"Bernard",
"lastname":"Sanders",
"address1":"A",
"address2":"B",
"postalCode":"13100",
"city":"PARIS",
"phone":"01234567890",
"email":"test@calinda.fr",
"creationDate":1456913816030,
"lastModificationPlace":"SERVER",
"companyName":"yourcompany",
"country":"FR",
"cellPhone":"01234567890",
"jobTitle":"Director",
"registrationNumber":"SIRET",
"birthdate":-1,
"birthplace":"",
"customerCode":"AM201603021055"}

Retrouver un client existant par son numéro

Si vous savez que votre client existe déjà dans SELL&SIGN et possédez son numéro de client, vous pouvez vérifier ses informations simplement par la méthode getCustomer :

https://[host]/calinda/hub/selling/model/customer/read?action=getCustomer&number=[numero de client]

Pour un client donné, vous pouvez également retrouver la liste des signataires associés à ce client en utilisant la méthode getContractorsFor :

https://[host]/calinda/hub/selling/model/contractor/read?action=getContractorsFor&number=[numero de client]&offset=0&size=100

(les paramètres offset et size peuvent vous permettre paginer de grandes quantités de donnée)

Ajouter des propriétés métier aux fiches client

Sur un client, il est possible d’ajouter des champs (propriétés) libres associés à votre métier. Avec votre numéro de client unique, vous pouvez récupérer ou affecter des valeurs sur des champs libres.

  1. Retrouver des propriétés spécifiques d’un client.
  2. Créer ou modifier la valeur d’un champ libre Client

Retrouvez en détail comment gérer ces propriétés sur la page : API : Ajout de propriétés spécifiques au Client

API : Création du client
3 (60%) 2 votes