OmniStor API

OmniStor API

OmniStor API 概述

OmniStor 除了提供檔案基本操作的 API 外,還包括取得相片的縮圖、影片的截圖、以及萃取文件內容等功能;以通用的 HTTPS 協定進行資料傳輸,提供高度互通性,並廣泛支援多種開發環境,且透過 SSL 2048bit 加密增加資料安全性。 您須遵循一致的原則使用創意雲 API 來存取資料:

  • 取得使用者所屬服務區域
    為達到「就近服務」的原則,OmniStor 在多個地區建置機房以提高傳輸的速度;因此您必須先取得使用者所屬服務區域,才能進行資料存取。
  • 取得授權
    通過嚴謹、安全的帳號驗證程序取得授權 Token,並在每一次 API 使用時帶入 Token。
  • 瀏覽或操作檔案及目錄
    透過HTTPS通用協定可輕易操作檔案及目錄等資源。

系統架構

範例程式

我們提供了數種程式語言的範例程式(仍會持續增加),可以加速您對 API 的熟悉度。
欲知更詳細的內容,請參考API 文件的下載範例程式

閱讀說明

此段落將說明如何閱讀 API 文件( 帳號認證、取得資訊、檔案/目錄基本操作、檔案上傳/下載、資料分享、關鍵字查詢 )中的 XML Payload ( 即各個 API 的 Input、Output )。

範例

下方為 API :「取得檔案或目錄相關資料(/fsentry/getentryinfo/)」 傳給伺服器的XML Payload ( 該 API 的Input )


<!--?xml version="1.0" encoding="utf-8"?-->
<getentryinfo>
	<token>{ token }</token><!-- 授權金鑰(Token) -->
	<isfolder>[ 0 | 1 ]</isfolder><!-- 0:表示為File ID | 1:表示Folder ID -->
	<entryid>[ File ID | Folder ID ]</entryid>
</getentryinfo>
                          

範例說明


參數欄位 說明
<token>{ token }</token> 參數欄位可輸入的值以 { } (大括號)做為表示。
如左例:填入授權 Token 的值於參數 token中。
實際範例:Token = frxqymeu4zr96e
<token>frxqymeu4zr96e</token>
<isfolder>[ 0 | 1 ]</isfolder> 參數欄位 [ ] (中括號)表示有兩種情況以上的值可選擇其一輸入。
並以<!---->補充說明文字。
如左例:[ 0 | 1 ]意指可輸入0或是1。