
使用這些基本 REST API 最佳實踐構建出色的 API
1.在任何頁面的右上角,單擊您的配置文件圖標,然后單擊API密鑰。
2.在左側邊欄中點擊“添加”按鈕。這將為您的令牌創建一個新條目。
3.在“令牌名稱”下,輸入令牌的名稱。
4.(可選)在“說明”下,添加注釋以說明令牌的用途。
5.在“過期”下,選擇令牌的過期時間。
6. (for僅限管理員帳戶)如果您以管理員帳戶登錄,您還可以選擇令牌的所有者。令牌將為此用戶生成,并將代表該用戶通過API訪問資源。
7.單擊save按鈕.
點擊保存按鈕后,您的令牌將顯示在一個單獨的彈出表單中。這是我們向您展示代幣的唯一時間。你再也看不到它了。請將其保存在一個安全的地方,并使用它來訪問Coginiti API。
端點:{hostname}/API/v1/exec/script
請求類型:POST
結果格式:JSON
使用curl應用程序的請求示例:
curl -X POST '{hostname}/api/v1/exec/script' \
--header 'Authorization: Bearer _YOUR_ACCESS_TOKEN_HERE_' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"path": "@Personal/Reports/performance",
"params": {
"start_date": "2012-01-01",
"end_date": "2012-12-31"
},
"connection": {
"name": "My Connection"
}
}'
有效載荷:
名稱 | 描述 |
---|---|
路徑 | 目錄中目錄資源的絕對路徑。“@Personal”、“@Shared”、“@Legacy”用于指定目錄命名空間。 |
params | 對象,其參數名及其值需要傳遞到腳本中以替代$params。 |
connection.name | 的連接名稱 |
返回一個表示執行結果的對象,否則返回一個錯誤。
名稱 | 描述 |
---|---|
統計數據 | 統計對象。 |
stats.started_at | 執行開始時的時間戳。 |
stats.finished_at | 執行完成時的時間戳。 |
stats.duration_ms | 以毫秒為單位的執行持續時間。 |
結果 | 可選字段。如果執行返回任何數據,則包含結果數據集。 |
數據集對象具有以下結構:
名稱 | 描述 |
---|---|
列 | 查詢返回的列的名稱和類型的列表。 |
數據 | 查詢請求返回的行的列表。每一行本身都是一個列表,按照columns屬性指定的順序保存該行中列的值。 |
與給定執行相關聯的附加元數據作為HTTP頭傳遞。
名稱 | 描述 |
---|---|
X-Coginiti-執行開始時間 | 執行開始時的時間戳 |
響應示例(包括HTTP頭):
HTTP/2 200
Date: Wed, 01 Nov 2023 10:03:17 GMT
Content-Type: application/json
X-Coginiti-Execution-Started-At: 2023-11-01T10:03:17.354799859Z
Vary: Accept-Encoding
Server: envoy
{
"result": {
"columns": [
{
"name": "col_1",
"type": "INTEGER"
},
{
"name": "col_2",
"type": "STRING"
}
],
"data": [
[
1,
"a"
],
[
2,
"b"
]
]
},
"stats": {
"started_at": "2023-08-10T15:06:57.581939751Z",
"finished_at": "2023-08-10T15:07:57.581939751Z",
"duration_ms": 1000
}
}
Q:如何找到Coginiti API開放平臺
A:冪簡集成是國內領先的API集成管理平臺,專注于為開發者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關鍵詞搜索API(例如,輸入’Coginiti API開放平臺‘這類品類詞,更容易找到結果)、或者從API hub分類頁進入尋找。
Q:使用API????密鑰無效?
A:登錄您的儀表板并刪除與 API 密鑰關聯的應用程序。請注意,所有使用此 API 密鑰的應用程序/集成都將停止工作。
Q:Azure AD IdP租戶?
A:Amazon Redshift應用程序的Azure AD租戶ID(在IdP(Azure)上配置的公司租戶名稱)。
Q:Azure AD客戶端ID?
A:使用Azure AD服務對連接進行身份驗證時要使用的客戶端ID(設置Azure SSO配置時創建的Amazon Redshift應用程序的帶連字符的客戶端ID)。
Q:如何重新安裝Coginiti Pro?
A:1.使用Windows控制面板中的“添加或刪除程序”刪除Coginiti Pro。
2.轉到Windows資源管理器,導航到C:/Users/username/AppData/Local/Aginity目錄,并將aginity-pro重命名為OLD-aginity-pro。 如果你愿意,我們可以恢復舊版本。 如果你不想再使用它,就把它取下來。
3.重新配置應創建新版本用戶文件的產品。
除了Coginiti API開放平臺,還有其他替代服務商也提供類似api服務,例如:
revocalize API開放平臺、DesiVocal API開放平臺、Speechify API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q:Coginiti API開放平臺這個密鑰還適用于哪些api?
本文全面而細致地介紹了獲取Coginiti API開放平臺密鑰的完整流程,為開發者們提供了一份條理清晰、易于操作的分步指南。從Coginiti API平臺的賬號注冊,到開發者身份驗證的順利完成,再到API服務密鑰的成功獲取,每一步操作都配以詳盡的說明與指導,確保開發者能夠輕松、準確地完成整個流程。本文特別強調了進行可用性測試的重要性,這不僅有助于開發者了解API的性能和穩定性,更是確保API能夠順利集成到應用中并發揮最佳效果的關鍵一步。通過測試,開發者可以及時發現并解決潛在的問題,從而提升應用的性能和用戶體驗。本文為開發者們提供了一個全面、詳盡且極具實用價值的操作指南,幫助他們順利獲取Coginiti API開放平臺的密鑰,并將這一強大的數據處理能力有效地集成到應用中。我們相信,隨著開發者們對這一指南的深入理解和實踐,將能夠充分利用Coginiti API的優勢,為應用的智能化、高效化發展注入新的動力,進一步推動數字創新和應用升級。