Intégration Fenestratio

Mise à jour le 15 janvier 2020

La page ".../api.jsp" de Fenestratio est conçue pour traiter les demandes provenant d'autres logiciels. Toutes les méthodes sur api.jsp doivent être invoquées par des requêtes https.

Le serveur de connexion active de Fenestratio peut être localisé en lisant le fichier:

https://www.fenestratio.com/appfind.htm

...qui contiendra quelque chose comme sv10.fenestratio.com

findCustomers

findCustomers recherche les clients de Fenestratio dans les champs nom et téléphone pour la chaîne.
exemple (quelques encodages d'url omis):


    https://.../api.jsp?fn=findCustomers&sv=Smith&mr=20
    
or

    https://.../api.jsp?fn=findCustomers&sv=555-555-1212&mr=20

Paramètres Https:

fn : nom de la fonction - toujours findCustomers - obligatoire
apiuid : identifiant de connexion Fenestratio de l'appelant - obligatoire
apipwd : mot de passe Fenestratio de l'appelant - obligatoire
sv : valeur de recherche - minimum 3 caractères - obligatoire
mr : résultats maximaux ≥ 20 ≤ 300

Retour JSON:

extraits:
- {ok:1,fn:"findCustomers",sv:"Smith",rc:395,
  rr:[
  {Customer:9373, Name:"Ackerson, Charles & Mary", Address:"123 some street", City:"Chicago", Phone:"555-555-1212", Phone2:"555-555-1313", Phone3:"", OtherSystemCode:"ae39239ds832ff"},
  {...}
- {security:1,fn:"findCustomers",sv:"Smith"}
- {exc:"Unexpected error....",fn:"findCustomers",sv:"Smith"}
- {ee:["Request logic error 1","Request Logic error 2"],fn:"findCustomers",sv:"Smith"}
Éléments de retour:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- fn : toujours findCustomers
- sv : valeur de recherche de l'appelant transmise
- rc : nombre total de clients qualifiés
- rr : tableau des résultats de la recherche de clients, limité par le paramètre de requête mr - éléments:
  - voir les éléments de retour selectCustomer ci-dessous

Règles:

la valeur de recherche doit être d'au moins 3 caractères

listContacts

..retournera les contacts d'un client.

exemple (quelques encodages d'url omis):
https://.../api.jsp?fn=listContacts&Customer=11

Paramètres Https:

fn : nom de la fonction - toujours createCustomer - obligatoire
apiuid : identifiant de connexion Fenestratio de l'appelant - obligatoire
apipwd : mot de passe Fenestratio de l'appelant - obligatoire
Customer : Identifiant du client Fenestratio - nombre entier facultatif
OtherSystemCode : comment le système d'appel identifie le client - 50 caractères

Retour JSON:

extraits:
- {ok:1,fn:"listContacts",OtherSystemCode:"ae39239ds832ff",Customer:9238, rr:[
  {Name:"Bob Jones", Mail:"bob@nospam.org", PhoneCell:"1234567890", PhoneWork:"5589324858", Inactive:false},
  {...}, ]}
- {security:1,fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {dup:1,fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {exc:"Unexpected error....",fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {ee:["Request logic error 1","Request Logic error 2"]",fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
Éléments de retour:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- fn : toujours listContacts
- OtherSystemCode : valeur de recherche de l'appelant transmise
- Customer : Numéro de client Fenestratio en cas de succès, ou absent

Règles:

soit Customer ou OtherSystemCode doivent être fournis.

listUsers

listUsers énumérera tous les utilisateurs internes de Fenestratio. Les marchands et les contractants ne seront pas énumérés.
exemple (quelques encodages d'url omis):


    https://.../api.jsp?fn=listUsers

Paramètres Https:

fn : nom de la fonction - toujours listUsers - obligatoire
apiuid : identifiant de connexion Fenestratio de l'appelant - obligatoire
apipwd : mot de passe Fenestratio de l'appelant - obligatoire

Retour JSON:

extraits:
- {ok:1,fn:"listUsers"
  rr:[
  {UserRow:2, UserName:"Terry Jones", EMail:"fred@fenestratio.com", Branch:1, Inactive:false, Service:true, Sales:true, CanMeasure:true, CanDeliver:true, OtherSystemCode:"239s8e93sw33"},
  {...} ]}
- {security:1,fn:"listUsers"}
- {exc:"Unexpected error....",fn:"listUsers"}
Return elements:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- fn : toujours listUsers
- rr : tableau de résultats - éléments:
  - UserRow : Identifiant de l'utilisateur de Fenestratio
  - UserName: nom d'utilisateur
  - EMail: courriel
  - Branch: succursale
  - Install : l'utilisateur peut être programmé pour effectuer des installations
  - Service : l'utilisateur peut être programmé pour effectuer des appels de service
  - Sales : l'utilisateur peut effectuer des ventes
  - CanMeasure : l'utilisateur peut être programmé pour effectuer des mesures
  - CanDeliver : l'utilisateur peut être programmé pour effectuer des livraisons
  - OtherSystemCode : autre code système

selectCustomer

selectCustomer permet de retrouver un client par son numéro d'identification Fenestratio ou OtherSystemCode.
exemple (quelques encodages d'url omis):


    https://.../api.jsp?fn=selectCustomer&Customer=10
    
ou

    https://.../api.jsp?fn=selectCustomer&OtherSystemCode=abc128

Paramètres Https:

fn : nom de la fonction - toujours selectCustomer - mandatory
apiuid : identifiant de connexion Fenestratio de l'appelant - mandatory
apipwd : mot de passe Fenestratio de l'appelant - mandatory
Customer : nombre entier facultatif
OtherSystemCode : facultatif - 50 caractères

Retour JSON:

extraits:
- {ok:1,fn:"findCustomers",Customer:9373,OtherSystemCode:"",
  rec:{Customer:9373, Name:"Ackerson, Charles & Mary", Address:"123 some street", City:"Chicago", Phone:"555-555-1212", Phone2:"555-555-1313", Phone3:"", OtherSystemCode:"ae39239ds832ff", CreatedAtLocal:"2018-11-04 16:12:00", CreatedAtUTC:"2018-11-04 22:12:00", UpdatedAtLocal:"2019-04-17 11:09:00", UpdatedAtUTC:"2019-04-17 17:09:00", contacts:[
  {Name:"Charles", Mail:"charles@bigco.com", PhoneCell:"7055551212", PhoneWork:"7055554444 ext 5530"} ,{...} ] }
  }
- {security:1,fn:"selectCustomer",Customer:9373,OtherSystemCode:""}
- {exc:"Unexpected error....",fn:"selectCustomer",Customer:9373}
- {ee:["Request logic error 1","Request Logic error 2"],fn:"selectCustomer",Customer:9373}
Éléments de retour:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- fn : toujours selectCustomer
- Customer : valeur du client de l'appelant transmise
- OtherSystemCode : valeur OtherSystemCode de l'appelant transmise
- rec: Dossier du client
  - Customer : Identifiant client Fenestratio
  - Name (Nom)
  - Address (Adresse)
  - City (Ville)
  - State (État)
  - Country (Pays)
  - Phone (Tél.)
  - Phone2 (Tél. 2)
  - Phone3 (Tél. 3)
  - Fax
  - Tax Group (Groupe fiscal)
  - Lead Source (Source principale)
  - OtherSystemCode (Code d'un autre système)
  - CreatedAtLocal (Créé à l'heure locale) - aaaa-mm-jj hh:mm:ss
  - CreatedAtUTC (Créé au temps universel coordonné (UTC))- aaaa-mm-jj hh:mm:ss
  - UpdatedAtLocal (Mise à jour à l'heure locale) - aaaa-mm-jj hh:mm:ss
  - UpdatedAtUTC (Mise à jour à l'UTC)- aaaa-mm-jj hh:mm:ss
  - contacts - array (tableau)

upsertContact

upsertContact créera ou mettra à jour un contact dans Fenestratio pour l'autre code système du client transmis ou l'identifiant du client Fenestratio.

exemple (quelques encodages d'url omis):
https://.../api.jsp?fn=upsertContact&co=Mary&cc=5555551213&em=mary@nospam.org&os=ae39239ds832ff
ou
https://.../api.jsp?fn=upsertContact&co=Mary&cc=5555551213&em=mary@nospam.org&ro=11

Si le nom, l'adresse électronique ou le téléphone portable transmis correspond à un contact existant pour le client, Fenestratio mettra à jour les autres valeurs, sinon Fenestratio créera un nouveau contact. Paramètres Https:

fn : nom de la fonction - toujours upsertContact - obligatoire
apiuid : identifiant de connexion Fenestratio de l'appelant - obligatoire
apipwd : mot de passe Fenestratio de l'appelant - obligatoire
Name : nom - obligatoire 80 caractères
Mail : courriel: 255 caractères
PhoneCell : numéro de téléphone portable - 10 caractères AAAXXXNNNN NON compris l'indicatif du pays
PhoneWork : numéro de téléphone au travail - 10 caractères AAAXXXNNNN NON compris l'indicatif du pays
OtherSystemCode : comment le système d'appel identifie le contact - 50 caractères
Customer : Identité du client Fenestratio

Retour JSON:

extraits:
- {ok:1,fn:"upsertContact",OtherSystemCode:"ae39239ds832ff",Contact:9238,OtherSystemCode:"ae39239ds832ff"}
- {security:1,fn:"upsertContact",OtherSystemCode:"ae39239ds832ff"}
- {exc:"Unexpected error....",fn:"upsertContact",OtherSystemCode:"ae39239ds832ff"}
- {ee:["Request logic error 1","Request Logic error 2"]",fn:" upsertContact",OtherSystemCode:"ae39239ds832ff"}
Éléments de retour:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- fn : toujours upsertContact
- OtherSystemCode : identifiant de contact de l'appelant
- Contact : Numéro de contact de Fenestratio en cas de succès

Règles:

les valeurs optionnelles non transmises ne seront pas mises à jour

upsertCustomer

..créera ou mettra à jour un client dans Fenestratio pour l'autre code système transmis, et renverra l'identifiant du client Fenestratio.

exemple (quelques encodages d'url omis):
https://.../api.jsp?fn=createCustomer&nm=Smith, Mary %26 John&ad=123 some street&ct=Chicago &st=IL&cn=USA&pc=22456&p1=555-555-1252&fx=555-555-1213&em=mary@nospam.org &tc=HST&ls=Yellow Pages&os=ae39239ds832ff

Paramètres Https:

fn : nom de la fonction - toujours createCustomer - obligatoire
apiuid : identifiant de connexion Fenestratio de l'appelant - obligatoire
apipwd : mot de passe Fenestratio de l'appelant - obligatoire
Customer : Identifiant du client Fenestratio - nombre entier facultatif
Name : obligatoire sur l'insertion - "dernier, premier1 et premier2" meilleur pour Fenestratio - 255 caractères - DOIT ÊTRE UNIQUE
Address : adresse postale - 50 caractères
City : ville - 35 caractères
State : doit correspondre aux abréviations définies dans Administration→États (ISO)
Country : 50 caractères
Postal : postal/zip code - 10 caractères
Phone : tél. 1 - 50 caractères
Phone2 : tél. 2 - 50 caractères
Phone3 : tél. 3 - 50 caractères
Fax : fax - 50 caractères
TaxGroup : doit correspondre à Administration→Groupe fiscal ; si elle n'est pas trouvée, elle sera définie par défaut à partir des paramètres de la compagnie.
LeadSource : lié à Entretien→Sources principales - les nouvelles entrées créeront une nouvelle source principale - 45 caractères
OtherSystemCode : comment le système d'appel identifie le client - 50 caractères
ContactName : nom du contact principal - utilisé uniquement dans I'insertion - 80 characters
ContactMail : courriel du contact principal - utilisé uniquement dans I'insertion - 255 characters
ContactCell : numéro de tél. du contact principal - utilisé uniquement dans I'insertion - 10 caractères AAAXXXNNNN NON compris le code du pays
ContactOtherSystemCode : comment le système d'appel identifie le contact - 50 caractères

Retour JSON:

extraits:
- {ok:1,fn:"createCustomer",OtherSystemCode:"ae39239ds832ff",Customer:9238}
- {security:1,fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {dup:1,fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {exc:"Unexpected error....",fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
- {ee:["Request logic error 1","Request Logic error 2"]",fn:"createCustomer",OtherSystemCode:"ae39239ds832ff"}
Éléments de retour:
- ok : soit 1 en cas de succès, soit absent, soit 0 en cas d'échec
- security : échec de la connexion
- dup: un client avec le nom exact transmis existe déjà
- fn : toujours createCustomer
- OtherSystemCode : l'identifiant du client de l'appelant est transmis
- Customer : Numéro de client Fenestratio en cas de succès, ou absent

Règles:

les valeurs optionnelles non transmises ne seront pas mises à jour
si le nom exact du client existe déjà et que ni Customer ni OtherSystemCode ne sont trouvés, la réponse inclura l'élément dup:1.

Fenestratio

Simplifier les fenêtres

Intégration Fenestratio

méthodes api.jsp

findCustomers

listContacts

listUsers

selectCustomer

upsertContact

upsertCustomer