測試資訊
測試用access_token
20f07f91f3303b2f66ab6f61698d977d69b83d64
注意:測試使用者產生的連結產生一小時後會自動失效,僅提供轉址與分析測試用,若需要正式的access_token請於網頁下方申請
產生短網址
GET路徑
https://api.pics.ee/v1/links/?access_token=20f07f91f3303b2f66ab6f61698d977d69b83d64
POST參數
{
"url":"https://blog.eilis-ai.com/eilis%E6%96%B0%E5%8A%9F%E8%83%BD%E4%B8%8A%E7%B7%9A-%E7%B8%AE%E7%9F%AD%E5%9D%80%E6%9C%8D%E5%8B%99picsee-585ddda961f9",
"externalId":"customer_test_1"
}
POST參數必須使用「raw」的「appliction/json」格式,參數說明:
● url:必填,原始網址,若網址路徑若包含UTF-8字元,必須編碼
● externalId:選填,將網址群組起來以便讀取整組連結成效
回傳結果範例
{
"data": {
"picseeUrl": "https://pse.ee/6UUKK"
},
"meta": {
"version": "1.0.0",
"request": {
"url": "/links",
"query": {
"access_token": "20f07f91f3303b2f66ab6f61698d977d69b83d64",
"url": "https://blog.eilis-ai.com/eilis%E6%96%B0%E5%8A%9F%E8%83%BD%E4%B8%8A%E7%B7%9A-%E7%B8%AE%E7%9F%AD%E5%9D%80%E6%9C%8D%E5%8B%99picsee-585ddda961f9",
"externalId": "customer_test_1"
}
}
}
}
其中picseeUrl值即為短網址,本服務亦提供自訂短網域功能,請參閱申請頁面
注意:測試使用者產生的連結產生一小時後會自動失效,僅提供轉址與分析測試用,若需要正式的access_token請於網頁下方申請
客製化縮圖短網址
GET路徑
https://api.pics.ee/v1/links/?access_token=20f07f91f3303b2f66ab6f61698d977d69b83d64
POST參數
{
"url":"https://picsee.co/developers/",
"externalId":"customer_test_1",
"title":"PicSee 皮克看見 Customized Title",
"description":"PicSee Customized Description",
"imageUrl":"https://picsee.co/images/domain_long.png"
}
POST參數必須使用「raw」的「appliction/json」格式,參數說明:
● title:必填,要自訂的標題,若包含中文字元請用UTF-8編碼
● description:選填,要自訂的描述
● imageUrl:必填,給定預覽圖片的絕對路徑
回傳結果範例
{
"data": {
"picseeUrl": "https://pse.ee/76KLX"
},
"meta": {
"version": "1.0.0",
"request": {
"url": "/links",
"query": {
"access_token": "20f07f91f3303b2f66ab6f61698d977d69b83d64",
"url": "https://picsee.co/developers/",
"externalId": "customer_test_1",
"title": "PicSee 皮克看見 Customized Title",
"description": "PicSee Customized Description",
"imageUrl": "https://picsee.co/images/domain_long.png"
}
}
}
}
其中picseeUrl值即為短網址,本服務亦提供自訂短網域功能,請參閱申請頁面
讀取連結成效
GET路徑
https://api.pics.ee/v1/links/encodeId/overview?access_token=20f07f91f3303b2f66ab6f61698d977d69b83d64
其中「encodeId」為產生出之短網址編碼,如短網址為「https://pics.ee/6SLU7」則「encodeId」用「6SLU7」取代
POST參數:不適用
回傳結果範例
{
"data": {
"url": "https://picsee.co/developers/",
"picseeUrl": "https://pics.ee/6SLU7",
"createTime": "2018-04-11T15:24:19+08:00",
"externalId": "customer_test_1",
"totalClicks": 1234,
"uniqueClicks": 999
},
"meta": {
"version": "1.0.0",
"request": {
"url": "/links/6SLU7/overview",
"query": {
"access_token": "20f07f91f3303b2f66ab6f61698d977d69b83d64"
}
}
}
}
參數說明:
● totalClick:總點擊
● uniqueClick:不重複點擊,會去除已知機器人、未設定user_agent瀏覽器及重複閱讀瀏覽器
讀取整組連結成效
GET路徑
https://api.pics.ee/v1/links/overview?access_token=20f07f91f3303b2f66ab6f61698d977d69b83d64&search[externalId]=customer_test_1
其中「customer_test_1」為產生出之短網址externalId,使用情境如下:
● 提供Chatbot服務已有自己的客戶,針對不同客戶用不同externalId,就能查詢某位客戶的歷史紀錄
● 在不同檔期行銷活動使用不同的externalId,可以查詢特定檔期的整體成效
POST參數:不適用
回傳結果範例
{
"data": {
"totalClicks": 40,
"uniqueClicks": 30,
"links": [
{
"url": "https://picsee.co/developers/",
"picseeUrl": "https://pics.ee/6TGZP",
"externalId": "customer_test_1",
"createTime": "2018-04-16T11:45:32+08:00",
"totalClicks": 10,
"uniqueClicks": 8
},{
"url": "https://picsee.co/developers/",
"picseeUrl": "https://pics.ee/6TGZK",
"externalId": "customer_test_1",
"createTime": "2018-04-16T11:45:30+08:00",
"totalClicks": 11,
"uniqueClicks": 7
},{
"url": "https://picsee.co/developers/",
"picseeUrl": "https://pics.ee/6TGZI",
"externalId": "customer_test_1",
"createTime": "2018-04-16T11:45:28+08:00",
"totalClicks": 9,
"uniqueClicks": 8
},{
"url": "https://picsee.co/developers/",
"picseeUrl": "https://pics.ee/6TGZD",
"externalId": "customer_test_1",
"createTime": "2018-04-16T11:45:05+08:00",
"totalClicks": 10,
"uniqueClicks": 7
}
]
},
"meta": {
"version": "1.0.0",
"request": {
"url": "/links/overview",
"query": {
"access_token": "20f07f91f3303b2f66ab6f61698d977d69b83d64",
"search[externalId]": "customer_test_1"
}
}
}
}
參數說明:
● totalClicks:總點擊
● uniqueClicks:不重複點擊
● links:包含此externalId的連結詳細資訊