我們為想要將其應用程序和 Livelox 整合的應用程序開發人員,提供了公共 REST API (代表性狀態轉移的應用程式界面)。
需要 API key (API 密鑰) 才能將請求發送到 API,要獲取 API key,請聯絡 info@livelox.com ,提供你的應用程序的簡要說明,以及為什麼要將其與 Livelox 整合。API key 必須保密,因此不應嵌入終端用戶的應用程序中 (例如:手機應用程序)。
你的 API key 應為每個請求的 ApiKey
包含在 HTTP header (超文本傳輸協議的標頭) 內,確保使用獨有的 API key,而不是下面例子所示的 API key。
ApiKey: 559FCA56B17E48DDB971DEEF1E90C8F2
請負責任地使用 API,不要分享你的 API key,不要發送過多的請求,盡可能將數據緩存在你這一邊,我們保留暫停違規 API 用戶的權利,恕不另行通知。
GET https://api.livelox.com/events
以 JSON (Java 腳本對象符號) 格式,Livelox 活動的回覆。
所有參數都是可選的。
姓名 | 類別 | 描述 |
---|---|---|
from |
日期時間, yyyy-mm-ddThh:mm:ssZ |
UTC (世界標準時間) 時間間隔開始的搜索範圍。 |
to |
日期時間, yyyy-mm-ddThh:mm:ssZ |
要在 UTC (世界標準時間) 中進行搜索的時間間隔的結尾,時間間隔被認為在該時間之前立即結束。 |
q |
字串 | 用於搜索活動名稱或活動籌辦者的字串。 |
modifiedSince |
日期時間, yyyy-mm-ddThh:mm:ssZ |
只限 UTC (世界標準時間) 之後修改的活動的回覆。 |
latitude |
號碼 | 圓圈中心的緯度搜索範圍,與longitude 和radius 一起使用。 |
longitude |
號碼 | 圓圈中心的經度搜索範圍,與latitude 和radius 一起使用。 |
radius |
號碼 | 半徑搜索範圍 (以米為單位),與latitude 和 longitude 一起使用。 |
south |
號碼 | 邊界框南邊的緯度搜索範圍,與north , west 和east 一起使用。 |
north |
號碼 | 邊界框北邊的緯度搜索範圍,與south< , west 和east 一起使用。 |
west |
號碼 | 邊界框西邊的經度搜索範圍,與south< , north 和east 一起使用。 |
east |
號碼 | 邊界框東邊的經度搜索範圍,與south< , north 和west 一起使用。 |
countryId |
整數 | 籌辦活動的國家的識別碼 (ID)。 |
onlySearchable |
布林 (boolean) | 在 Livelox 開始頁面標記為可搜索為限的活動篩選結果,地圖和賽程連接無效的活動被認為是不可搜索的。 |
onlyHavingValidMapAndCourses |
布林 (boolean) | 有齊地圖和路線的活動篩選結果。 |
includeClasses |
布林 (bool) | 是否在反應中包括活動的組別, 默認是 true 。 |
includeProperties |
布林 (bool) | 是否在反應中包括活動核心價值的屬性, 默認是 true 。 |
cultureCode |
日期時間, yyyy-mm-ddThh:mm:ssZ |
本語言指定文化值 (例如: 國家名稱) 的回覆,默認是en-US 。 |
paging |
字串, index:size |
index 是從零開始的頁面索引的分頁結果; size 是每頁搜索結果的數量,例如:1:20 將回覆搜索結果的 21-40。 |
GET https://api.livelox.com/event/{eventId}
有關 Livelox 中指定活動詳細資料,以 JSON 格式的回覆。
姓名 | 類別 | 描述 |
---|---|---|
eventId |
整數 | 活動識別碼 (ID) |
所有參數都是可選的。
姓名 | 類別 | 描述 |
---|---|---|
includeClasses |
布林 (bool) | 是否在反應中包括活動的組別, 默認是 true 。 |
includeProperties |
布林 (bool) | 是否在反應中包括活動核心價值的屬性, 默認是 true 。 |
cultureCode |
日期時間, yyyy-mm-ddThh:mm:ssZ |
本語言指定文化值 (例如: 國家名稱) 的回覆,默認是en-US 。 |
GET https://api.livelox.com/orienteering/courses/iofxml
有關活動賽程的資料以 IOF XML (Extensible Markup Language 可延伸標記語言的賽程資料檔案) 格式的回覆,尚未公開的資料不會有回覆。
姓名 | 類別 | 描述 |
---|---|---|
eventId |
整數 | 需要的活動識別碼 (ID)。 |
projectionEpsgCode |
整數 | 應該表示控制點坐標的 EPSG (歐洲石油調查組織) 投影代碼,省略時會默認使用 WGS84 (1984年世界大地測量系統)。 |
includeControls |
布林 (boolean) | 是否包括賽程的控制點。 |
includeClassConnections |
布林 (boolean) | 是否包括賽程和組別連接,即組別的識別碼 (ID), 將 includeClasses (包括組別) 設定為 true,還可以包括組別的子對象。 |
includeClasses |
布林 (boolean) | 是否包括賽程的組別。 |
GET https://api.livelox.com/countries
Livelox中存在的所有國家,以 JSON 格式的回覆。.
有關 Livelox 中指定活動詳細資料,以 JSON 格式的回覆。
姓名 | 類別 | 描述 |
---|---|---|
cultureCode |
字串 | 國家名稱應使用的語言,默認是 en-US 。 |
onlyHavingEvents |
布林 (boolean) | 至少和一個活動相關的國家為限的回覆。 |