iGarment Wiki

User Tools

Site Tools

Trace:
en:server_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:server_api [2026/06/03 08:47] – administratoren:server_api [2026/06/03 09:55] (current) – [API URL] administrator
Line 2: Line 2:
  
 ===== Introduction ===== ===== Introduction =====
- 
  
 This article describe how to use API to exchange data with iGarment System. Please note that iGarment API infra structure can only work with Unicode (UTF8) data, thus only support if your company is using iGarment version 5 or above. This article describe how to use API to exchange data with iGarment System. Please note that iGarment API infra structure can only work with Unicode (UTF8) data, thus only support if your company is using iGarment version 5 or above.
  
-The exchange data is either JSON or XJSON depending on the HTTP Content-Type header. It is either application/json or application/xjson. XJSON (eXtended JSON) is a serialization notation design by iGarment Ltd. XJSON and JSON is interchangable. For details, please refer to the XJSON specification.+The exchange data is either JSON or XJSON depending on the HTTP Content-Type header. It is either application/json or application/xjson. XJSON (eXtended JSON) is a serialization notation design by iGarment Ltd. XJSON and JSON is interchangable. For details, please refer to the [[xjson|XJSON specification]].
  
 We use JSON Schema to specify our document, if you want to learn more about JSON Schema, you may like to visit the following sites: We use JSON Schema to specify our document, if you want to learn more about JSON Schema, you may like to visit the following sites:
Line 15: Line 14:
  
 ''Although the JSON Schema specification may use attribute $comment to specify a comment, but we find it may be too combersome to read. Instead we will use # to for a comment. Any text after the # are comment and we will preprocess the JSON Schema file by removing our comments before we submit to the validator.'' ''Although the JSON Schema specification may use attribute $comment to specify a comment, but we find it may be too combersome to read. Instead we will use # to for a comment. Any text after the # are comment and we will preprocess the JSON Schema file by removing our comments before we submit to the validator.''
- 
  
 ===== API URL ===== ===== API URL =====
Line 25: Line 23:
 https://api.igarment.net/jdoc/purchase_order/AX-10021 https://api.igarment.net/jdoc/purchase_order/AX-10021
  
 +**Authentication method**
  
 +To use iGarment API, you need to obtain a API KEY from your account manager and put the domain (database name) and the api-key in the Authorization Header of each HTTP request. Note that Authorization Header needs to be encoded in Base64.
  
 +Example, let said you want to send an api request for the domain 'demo'.
 +
 +  keyinfo = base64.b64encode(b'demo.igx-xxxxxxxxxxxxxxxxxxxxxxxxxx')
 +  headers = {'Authorization': keyinfo.decode()}
 +  
  
 (Example in Apifox) (Example in Apifox)
  
- +  var cryptoJs = require("crypto-js"); 
 +   
 +  const igx_key = 'demo.igx-xxxxxxxxxxxxxxxxxxxxxxxxxx' 
 +  const keyArray = cryptoJs.enc.Utf8.parse(igx_key); 
 +  pm.environment.set("igx_key", cryptoJs.enc.Base64.stringify(keyArray)); 
 +  
 ===== Error ===== ===== Error =====
  
Line 54: Line 63:
 ===== API Specification by catagory ===== ===== API Specification by catagory =====
  
-Database Query API (url: ~/db) +  * [[db_api|Database Query API]] 
-Document API (url: ~/jdoc)+ 
 +  * [[doc_api|Document API]]
  
en/server_api.1780476458.txt.gzip · Last modified: by administrator