Il est possible d’obtenir les données de Cienapps par l’entremise d’API. La présente documentation élabore sur les différentes sources d’informations disponibles et les opérations possibles. Pour de plus amples renseignements sur la disponibilité et l’accessibilité, veuillez communiquer avec votre responsable (chargé de comptes / chargé de projets).
Prérequis
Cette section élabore sur les conditions essentielles à l’activation et l’utilisation des APIs.
...
Note importante: par défaut, il est nécessaire d’indiquer la lecture et l'écriture. L'écriture permet de transférer les éléments de notifications en archive après lecture. Voir plus loin dans la documentation.
Les routes d’API
Cette section élabore sur les différentes routes d’API disponible avec le format d’appel et le fonctionnement.
...
Chaque header doit posséder la clé d’API spécifiée lors des appels d’API.
“APIToken”“ApiToken”: “clé_API_ici”
Fonctionnement
Après obtention des données sous format JSON, le membre ‘SyncID’ contient le ID de la notification. Après utilisation, il faut appeler l’API /sync/confirm avec un array contenant ce ID. Cela permet de retirer la notification après une lecture. Voir la section plus ci-dessous pour de plus amples détails.
Liste des commandes (https://serveur:port/api/sync/order/list) - GET
Cet API permet d’obtenir la liste des commandes ayant été modifiés. Voici les différents champs disponibles avec les détails.
...
"Order_Quotation_Number": [ 6122 ]
} ]
Liste des soumissions (https://serveur:port/api/sync/quotation/list) - GET
Cet API permet d’obtenir la liste des commandes ayant été modifiés. Voici les différents champs disponibles avec les détails.
...
[
{
"Quotation_Number": 6139,
"Quotation_DateCreate": "20231110",
"Quotation_DateClose": "20231110",
"Quotation_DateValidate": "20231124",
"Quotation_Reference_PO": null,
"Quotation_Reference": "SUNCRAFT 12345 WOODRUSH",
"Quotation_Step_Desc": "02 - QUOTING STAGE",
"Quotation_SalesRep_FullName": "MARII ALIKI",
"Quotation_SalesRep_UserName": "MALLIKIKI",
"Quotation_Rep_FullName": "VLADISLAV HELLO",
"Quotation_Rep_UserName": "VHELLO",
"Quotation_Title": "SUNCRAFT 12345 WOODRUSH",
"Customer_Last_Name": "SUNKRAFT CHEESE CONSTRUCTION",
"Customer_First_Name": null,
"Customer_Company_Name": null,
"Customer_Address": "PO BOX 9458 ",
"Customer_City": "DUNCAN",
"Customer_PostalCode": "V9L S0S",
"Customer_DateCreate": "2016-03-30 00:00:00.000",
"Customer_Rep": "VLADISLAV HELLO",
"Customer_Main_Phone": "(250) 748-1234",
"Customer_Origin": "CONTRACTOR / MAINTENANCE DEPARTMENT",
"SyncID": 12
}
]
Liste des bons de travail (https://serveur:port/api/sync/workorder/list) - GET
Cet API permet d’obtenir la liste des bons de travail ayant été modifiés. Voici les différents champs disponibles avec les détails.
...
[
{
"WorkOrder_Order_Number": 7953,
"WorkOrder_Number": "4704-1",
"AncienSoumission": 4704,
"WorkOrder_BackOrder": 0,
"WorkOrder_Step_Desc": "01 READY FOR PROCESSING - DO NOT OR",
"Customer_Last_Name": "YOUBOBO GENERAL STORE",
"Customer_First_Name": "CARRIE",
"Customer_Company_Name": "CAEKCEASAR",
"Customer_Address": "3455 FIND ME HWY",
"Customer_City": "CEDAR",
"Customer_PostalCode": "V9X1T8",
"Customer_DateCreate": "2023-11-08 00:00:00.000",
"Customer_Rep": "MARII ALIKIKI",
"Customer_Main_Phone": "(250) 616-1234",
"Customer_Origin": "REFERAL FROM CONTRACTOR / DESIGNER",
"WorkOrder_DateDue": "20231116",
"WorkOrder_DateDelivery": "20240102",
"WorkOrder_IDCust_Delivery": 0,
"WorkOrder_DateInstallation": "20240102",
"WorkOrder_Workflow": "JOB WITH FINISHING (PAINT OR STAIN)",
"Customer_Delivery_FullName": null,
"Customer_Delivery_Main_Phone": null,
"Customer_Delivery_Address": null,
"Customer_Delivery_City": null,
"Customer_Delivery_PostalCode": null,
"WorkOrder_Team_Delivery": "CAPACITY",
"WorkOrder_Team_Installation": "",
"WorkOrder_Close": 0,
"WorkOrder_Close_Date": null,
"SyncID": 13
}
]
Confirmer la lecture de Cietification (https://serveur:port/api/sync/confirm) - POST
Cet API permet de confirmer la lecture de cietifications (notifications) après appel d’un des API (workorder/list, quotation/list, order/list). Le traitement appelé par l’API retire la notification de la liste et le transfère dans un fichier d’historique. Dans le cas de cet API, le partenaire consommateur doit avoir la permission en écriture.
...