API 金鑰模式

1. 取得 API 金鑰

使用 OpenAPI 必須擁有一組專屬金鑰。UOF X 允許針對不同的外部系統（例如：ERP、HR、CIM...）分別建立專屬的 金鑰，並給予不同的權限與參數設定。

權限提醒

設定串接服務需要具有 公司管理員 權限。如果您不是公司管理員，請向貴公司的系統管理者請求協助。

操作步驟：

1. 登入 UOF X，從右上角的頭像切換為「管理員」。
2. 點選左邊選單的「系統管理」 > 「金鑰管理」。
3. 點選 產生金鑰，設定名稱後點選 複製。

詳細操作畫面請參考：使用手冊 - 金鑰管理

產生金鑰操作示意圖

---

2. 應用方式

取得金鑰後，您可以在任何支援 HTTP Request 的程式語言或工具（如 Postman）中使用。

參閱 API 文件 了解各項 API 的呼叫方式與參數定義。

請求格式說明

• Method: 依照各 API 定義 (GET, POST, PUT, DELETE)
• Header:
  • Api-Key: 您的 API 金鑰

程式碼範例

以下提供常見程式語言的呼叫範例，假設我們要呼叫一個取得使用者資訊的 API：

Node.jsC# (HttpClient)

使用 Node.js 進行串接時，推薦使用 axios 或原生的 fetch。

const axios = require('axios');

const config = {
  method: 'get',
  url: `https://your-site.uofx.com/openapi/base/v${version}/jobfunc`,
  headers: { 
    'CorpCode': '公司代碼', 
    'Api-Key': '您的_API_金鑰'
  }
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

.NET 開發者可使用 HttpClient 進行呼叫。

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.uofx.com/api/users/list");

// 加入 API 金鑰 Header
request.Headers.Add("Api-Key", "您的_API_金鑰");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);