AppScan api登录接口 postman_如何通过Postman调用EDI系统的API?
知行EDI系統主要是用來實現貿易雙方的數據交換的過程,這個過程中,貿易雙方往往需要根據國際通用的消息格式收發信息,我們稱符合國際規范的消息文件為EDI報文,然而不同的公司會結合ERP的接口情況選擇不同的集成方式,例如調用API,使用數據庫中間表,自定義XML,CSV,Excel等方式實現與ERP系統的集成,調用API的方式很常見,而且在知行EDI系統上所有的功能操作,都可以通過調用API來進行控制。下面我們會通過一個例子為您說明如何使用Postman 調用知行EDI系統的API。一方面您可以測試知行EDI系統的API功能;另一方面,當您使用C#,Java等語言調用API時若有報錯,可通過Postman進行問題定位,判斷是系統暴露API的問題,還是代碼的問題。
擴展閱讀:如何通過C#調用EDI系統的API?
1. EDI系統的API定義
進入知行EDI系統?的管理界面,點擊右上角導航欄中的”API”。您就可以看到知行EDI系統?默認提供的API接口,如下圖所示:
從圖中我們可以看到,知行EDI系統?的API是以OData協議方式暴露的。OData是一種流行的REST接口的包裝方式。知行EDI系統?默認遵從OData V4協議,其內容均以JSON方式傳輸。 點擊左邊列表中的任何一個鏈接,可以看到關于這個API的詳細描述。例如下圖中的“ports”接口,您可以通過描述頁面上的方法對知行EDI系統?中的端口(Port)進行增刪改查的操作。
其中,各個方法的功能如下表所示:
2. 知行EDI系統的安全認證
可以看到,知行EDI系統?提供了非常強大的接口功能?;旧?#xff0c;您可以用它完成任何在管理界面完成的工作。正因此,知行EDI系統?也提供了全面的安全認證方式。 首先, 進入管理界面的 “PROFILE” -> “Security”界面,如下圖,您可以在這里創建/修改調用API的用戶和IP地址。
如上圖,創建用戶時,只需點擊”User Permissions”下方的”Add”按鈕,就可以開始創建用戶了。這里, 需要輸入的是用戶名稱和其他的訪問權限。對于權限,您可以參考上面我們列出的表格。幾種方法分別這對于增刪改查四種操作。保存之后, 您剛創建的用戶就會出現在表中,并且他會被賦予一個隨機的Authtoken。 這個Authtoken就可以被用于API調用的權限認證。另外,這里創建的用戶,不同于知行EDI系統的登錄用戶,該用戶只被用于知行EDI系統的API訪問。
默認情況下,知行EDI系統?只允許本機訪問API。 如果您希望從其他電腦/平臺訪問API。 那您就需要將其來源IP地址加入”Trusted IP Address”表。點擊其下的”Add”按鈕就可以增加一個來源IP地址。 注意, 輸入”* ”將會使知行EDI系統?允許任何來源。 當然, 您可以使用類似于”192.168.* “這樣的配置來允許一個網段的訪問。
3. 使用Postman調用EDI系統的API
在了解了知行EDI系統對于API的定義和安全機制后,下面我們將使用Postman來實現對AS2端口文件列表的獲取、文件內容的獲取以及文件的上傳。此時我們假設,知行EDI系統?已有一個AS2端口(PortId=AS2_testAPI),其用于和A公司做EDI報文的收發操作?,F在我們需要將生成的EDI文件上傳給這個AS2端口。同時,我們也需要檢查AS2端口的接收文件隊列,獲取最近收到的EDI文件。
3.1 獲取文件列表
使用Postman獲取文件列表之前,需要添加Header的屬性和對應的值,如下表:
這里的x-rssbus-authtoken屬性的值即剛剛為用戶Celine分配的隨機Authtoken。 我們選擇Http請求的類型為Get,將URL:http://localhost:8001/api.rsc/files?PortId=AS2_testAPI&Folder=Receive.輸入到對應的鏈接欄中,點擊send,將看到下方的Body中返回的JSON格式的文件列表,如下圖:
對比下圖所示的知行EDI系統管理界面的文件,我們可以看到通過Postman成功獲取了AS2端口的文件列表。
3.2 獲取文件內容
有了使用Postman獲取文件列表的基礎,我們只需要將URL修改為:http://localhost:8001/api.rsc/files(<PortId=(PortId),Folder=(Folder),Filename=(Filename),MessageId=(MessageId)>) 的格式,即可獲取指定的文件內容,如下圖:
3.2 上傳文件
上傳文件到AS2端口,就需要使用POST請求,此時我們將請求方式選為POST,并在鏈接欄輸入URL:http://localhost:8001/api.rsc/files/ , 而文件的內容需要在Body中,以JSON的格式發送,如下圖:
這時查看知行EDI系統管理界面AS2端口的Input界面,如下圖,發現已經成功上傳了文件名為test.edi的文件。
4. 關于Postman
Postman是一款模擬http請求的工具軟件,支持多種Http請求方式,為程序開發人員提供了一種測試工具。 Postman的官網下載鏈接:https://www.postman.com/downloads/。
[Share] 如何通過Postman調用EDI系統的API??www.kasoftware.com總結
以上是生活随笔為你收集整理的AppScan api登录接口 postman_如何通过Postman调用EDI系统的API?的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 《王者荣耀》新版本将优化对局环境,重点干
- 下一篇: windows redis批量删除前缀的