無名小站 API 文件 - Version 1.2 Preview

API 中需驗證的方法

所有與使用者私人資料有關的都需要使用 OAuth 做驗證, 請參考此篇文章: Yahoo! OAuth Quick Start Guide

API 存取方式:

http://wretch.yahooapis.com/v1.2/[API Method]?[Parameters]

API 的輸出格式:

Wretch API 提供兩種輸出格式: XML 與 JSON, 可使用 format 參數來指定回傳的格式 (例如: format=json). 或在發出 Request 時, 指定 header 為 application/xml 或 application/json.

若status_code=200, 表示query format正確, 且有 result
若status_code=404, 表示query format有誤, 包含: error typing, 格式錯誤, 或是此resource不存在 (ex: 沒開啟服務) 等
若status_code=406, 表示沒有指定valid accept format (包含 application/xml 及 application/json), 請用 format 參數指定或是在request header中的 accept 指定為 valid value

API 方法列表:

功能說明 (Detail)

取得指定的網誌的文章列表.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/blogService/{guid|wid}/articles

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 筆,最多 20 筆 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/blogService/6GEBDOA3NFVOOXL5TZVBDGNZNI/articles?start=1&count=10

http://wretch.yahooapis.com/v1.2/blogService/openapi01/articles?start=1&count=10

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
article_id 正整數 文章編號 32331733
post_time 日期 文章發表日期 (年-月-日 時:分) 2011-01-06 02:22
title 字串 文章標題 下午茶 (二)
author 字串 文章作者的無名帳號 openapi01
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Private
url 網址 文章網址 http://www.wretch.cc/blog/openapi01/32331733
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

在指定的網誌發表新文章.

只有版主和共筆作者能發表文章.

不提供分享最新動態到 Yahoo 奇摩或 Facebook 的功能.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/blogService/{guid|wid}/articles

通訊方式 (HTTP Method)

POST

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01

以下參數必須以 "XML的格式" 帶在 "Content" 中
參數名稱 是否必填 參數型態 說明 預設值 範例
title 字串 文章標題
下午茶 (二)
text 字串 文章內容
內容II內容II內容II
site_category_id 正整數 全站分類. 如果未填寫或指定的分類不存在, 則使用系統建議分類 系統自動決定
229
user_category_id 正整數 個人分類 0
12
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Public
Private
key 字串 通關密碼. 只有在保護方式是 Password_Protected 的時候此參數才有意義, 至少五個字數,且需同時包含英文字母與數字
25th-April
key_note 字串 通關密碼提示
我的生日
friend_group 正整數 好友保護的群組編號. 只有在保護方式是 Friend_only 的時候此參數才有意義. 預設是開放給所有好友.
當共筆作者在發表文章時, 這個欄位仍然是使用板主的好友群組編號.
0
0
allow_comment 指定字串 回應權限: wide_open, Members_Only, Friends_Only, No_one wide_open
No_one
trackback_url 字串 引用通知
set_cover 指定字串 設為置頂文章: true, false false
false
post_time 日期字串 調整發文時間 (年-月-日 時:分) 現在時間
2011-01-06 02:22

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/blogService/6GEBDOA3NFVOOXL5TZVBDGNZNI/articles
or
http://wretch.yahooapis.com/v1.2/blogService/openapi01/articles

POST 協定中的參數:

<?xml version="1.0" encoding="UTF-8"?>
<req>
  <title>我是標題</title>
  <text><[CDATA[我是內容內容內容內容內容]]></content>
  <url></url>
</req>

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
article_id 正整數 文章編號 32331733
url 網址 文章網址
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得指定的文章.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/blogService/{guid|wid}/article/{article_id}

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
article_id 正整數 文章編號 31259913

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/blogService/6GEBDOA3NFVOOXL5TZVBDGNZNI/article/31259913
or
http://wretch.yahooapis.com/v1.2/blogService/openapi01/article/31259913

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
url 網址 文章網址 http://www.wretch.cc/blog/openapi01/32331733
blog_name 字串 網誌名稱 my blog
title 字串 文章標題 下午茶 (二)
author 字串 文章作者的無名帳號 openapi01
post_time 日期字串 發文時間 (年-月-日 時:分) 2011-01-06 02:22
text_abstract 字串 文章內容預覽 內容II內容II內容II
text 字串 文章內容 內容II內容II內容II
site_category_id 正整數 全站分類編號 226
site_category_name 字串 全站分類 心情小語
user_category_id 正整數 個人分類編號 0 12
user_category_name 字串 個人分類 閒聊
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Public Private
allow_comment 指定字串 回應權限: Wide_open(完全開放回應), Members_Only(僅開放會員回應), Friends_Only(僅開放好友回應), No_one(不允許回應) wide_open No_one
today_counter 正整數 當日人氣 0 0
total_counter 正整數 累積人氣 0 0
total_recommend 正整數 推薦次數 0 0
total_comment 正整數 回應次數 0 0
total_trackback 正整數 引用次數 0 0
total_collection 正整數 有多少人收藏了這篇文章 0 0
img 網址 文章內的第一個圖片網址
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得指定的使用者的相簿列表. 回應的內容會依照訪客的身分而有所不同.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/albumService/{guid|wid}/albums

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 張相片,最多 20 張 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/albumService/6GEBDOA3NFVOOXL5TZVBDGNZNI/albums?start=1&count=10
or
http://wretch.yahooapis.com/v1.2/albumService/openapi01/albums?start=1&count=10

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
book_id 正整數 相簿編號 2
status 字串 相簿保護方式:
Public (完全開放), Private (完全隱藏), Password_Protected (通關密碼), Friends_only (好友保護)
Public
title 字串 相簿主題 openapi test 2
cover 網址 封面照片的網址,如果此相簿沒有設定封面相片則傳回空字串 http://f11.wretch.yimg.com/openapi01/2/thumbs/t1401889777.jpg?4hjKg09DcBbuRJihFIfNthmE85CoqgwkD3efYusHgtKaZoJadJObA.o3BRsR
lastModTime 日期 相簿最後修改時間 (YYYY-MM-DD HH:ii:ss) 2009-04-21 17:04:33
location_area 字串 相簿地點 - 區域 台灣 台灣
location_city 字串 相簿地點 - 城市 空字串 南投縣
num_pics 正整數 相簿內的相片數量 0 12
site_category_id 正整數 全站分類編號 0 112
site_category_name 字串 全站分類 空字串 國內旅遊
today_counter 正整數 當日人氣 0 39
total_counter 正整數 累積人氣 0 455
user_category_id 正整數 個人分類編號 0 2
user_category_name 字串 個人分類 空字串 test category 2
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

上傳一張照片並存入使用者的某一本相簿

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/albumService/{guid|wid}/{book_id}

通訊方式 (HTTP Method)

POST

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 3FH7YZZWCUXHOQJNY6AQZPGDOI 或 wretchuser
book_id 正整數 相簿編號 10

以下參數必須以 "XML的格式" 帶在 "Content" 中
參數名稱 是否必填 參數型態 說明 預設值 範例
content 圖片檔案內容 以 Base64 編碼後的照片內容
/9j/4AAQSkZJRgABAQEAYABgAAD/4QBmRXhpZgAASUkqAAgAAAAEABoBBQABAAAAPgAAABsBBQABAAAARgAAACgBAwABAAAAAgAAADEBAgAQAAAATgAAAAAAAABgAAAAAQAAAGAAAAABAAAAUGFpbnQuTkVUIHYzLjM2AP/bAEMAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAf/bAEMBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAf/AABEIAAEAAQMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APxfooor/Kc/7+D/2Q
title 字串 相片標題
阿里山遊記大合照
description 字串 相片描述
離開前在阿里山車站的團體大合照
quality 特定數字 縮圖品質: 0 (最佳品質), 1 (標準), 2 (最省空間) 1
3
thumb_type 特定字串 縮圖尺寸: small (640x640), medium (800x800), large (1024x1024), origin (原始尺寸) small
large
upload_to_front 特定字串 上傳後將照片放在最前面: true (是), false (否) false
true
exif_orientation 特定字串 上傳後依照 "相片資訊" 自動調正: true (是), false (否) false
true

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/albumService/ZKWHF6P5LXDZSICROTM76OS4CI/album/1

http://wretch.yahooapis.com/v1.2/albumService/wretchuser/album/1

參數:

<?xml version="1.0" encoding="UTF-8"?>
<req>
  <title>myphoto</title>
  <content><[CDATA[/9j/4AAQSkZJRgABAQEAYABgAAD/4QBmRXhpZgAASUkqAAgAAAAEABoBBQABAAAAPgAAABsBBQABAAAARgAAACgBAwABAAAAAgAAADEBAgAQAAAATgAAAAAAAABgAAAAAQAAAGAAAAABAAAAUGFpbnQuTkVUIHYzLjM2AP/bAEMAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAf/bAEMBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAf/AABEIAAEAAQMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APxfooor/Kc/7+D/2Q]]></content>
</req>

回應參數 (Response Parameters)

回應範例 (Response Example)

功能說明 (Detail)

取得 user 的某一張相片的相關資訊 (Retrieve detail information for specific photo)

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/albumService/{guid|wid}/album/{book_id}/photo/{photo_id}

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
book_id 正整數 相簿編號 2
photo_id 正整數 相片編號 1401889757

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/albumService/6GEBDOA3NFVOOXL5TZVBDGNZNI/album/2/photo/1401889757
or
http://wretch.yahooapis.com/v1.2/albumService/openapi01/album/2/photo/1401889757

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
title 字串 相片名稱 4903865438_f5deca59d7_m
description 字串 相片描述
pic_url 字串 相片連結
thumb_url 字串 相片縮圖連結
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得 User 某一本相簿之相片列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/albumService/{guid|wid}/album/{book_id}

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid or wid 字串 user guid or wid 6GEBDOA3NFVOOXL5TZVBDGNZNI or openapi01
book_id 正整數 album id 2
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設20張相片,最多20張 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/albumService/6GEBDOA3NFVOOXL5TZVBDGNZNI/album/2?format=xml http://wretch.yahooapis.com/v1.2/albumService/openapi01 /album/2?format=xml&start=1&count=20

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
album_name 字串 album_name openapi test 1
book_id 字串 book id 2
photo_id 正整數 photo id 1401889777
thumb_url 字串 small photo url http://f11.wretch.yimg.com/openapi01/2/thumbs/t1401889777.jpg?4hjKg09DcBbuRJihFIfNthmE85CoqgwkD3efYusHgtKaZoJadJObA.o3BRsR
img 字串 photo url http://f11.wretch.yimg.com/openapi01/2/1401889777.jpg?4hjKg09DcBbuRJihFIfNthmE85CoqgwkD3efYusHgtKaZoJadJObA.o3BRsR
title 字串 photo title IMG_0433
description 字串 photo description 2
lang 字串 language zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得使用者的個人名片資訊

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/profileService/{guid|wid}

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch ID) 3FH7YZZWCUXHOQJNY6AQZPGDOI 或 wretchuser

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/ProfileService/3FH7YZZWCUXHOQJNY6AQZPGDOI

http://wretch.yahooapis.com/v1.2/ProfileService/wretchuser

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
title 字串 標題 無名正妹
title_status 指定字串 "標題" 隱私狀態: Public (顯示), Private (隱藏) Public Private
description 字串 描述 無名第一正妹就是我
description_status 指定字串 "描述" 隱私狀態: Public (顯示), Private (隱藏) Public Private
nickname 字串 暱稱 正妹
nickname_status 指定字串 "暱稱" 隱私狀態: Public (顯示), Private (隱藏) Public Private
birthday 日期字串 (月/日) 生日 12/31
birthday_status 指定字串 "生日" 隱私狀態: Public (顯示), Private (隱藏) Public Private
introduction 字串 關於我 我是超級正妹
introduction_status 指定字串 "關於我" 隱私狀態: Public (顯示), Private (隱藏) Public Private
gender 指定字串 性別: Reserved (保留), Male (男), Female (女) Female
gender_status 指定字串 "性別" 隱私狀態: Public (顯示), Private (隱藏) Public Private
uri 網址 使用者名片頁網址 http://www.wretch.cc/user/wretchoffice
astrology 字串 星座 雙子座
astrology_status 指定字串 "星座" 隱私狀態: Public (顯示), Private (隱藏) Public Private
height 字串 身高 171~180
height_status 指定字串 "身高" 隱私狀態: Public (顯示), Private (隱藏) Public Private
weight 字串 體重 46~50
weight_status 指定字串 "體重" 隱私狀態: Public (顯示), Private (隱藏) Public Private
blood_type 字串 血型 AB
blood_type_status 指定字串 "血型" 隱私狀態: Public (顯示), Private (隱藏) Public Private
career 字串 職業 資訊
career_status 指定字串 "職業" 隱私狀態: Public (顯示), Private (隱藏) Public Private
company 字串 公司名稱 雅虎奇摩
company_status 指定字串 "公司名稱" 隱私狀態: Public (顯示), Private (隱藏) Public Private
elementary_school 字串 國民小學 臺北市立東門國民小學
elementary_school_status 指定字串 "國民小學" 隱私狀態: Public (顯示), Private (隱藏) Public Private
junior_high_school 字串 國民中學 臺北市立中正國民中學
junior_high_school_status 指定字串 "國民中學" 隱私狀態: Public (顯示), Private (隱藏) Public Private
senior_high_school 字串 高中/職 臺北市立第一女子高級中學
senior_high_school_status 指定字串 "高中/職" 隱私狀態: Public (顯示), Private (隱藏) Public Private
university 字串 大專院校 國立台灣大學
university_status 指定字串 "大專院校" 隱私狀態: Public (顯示), Private (隱藏) Public Private
graduate_school 字串 研究所 哈佛大學
graduate_school_status 指定字串 "研究所" 隱私狀態: Public (顯示), Private (隱藏) Public Private
optional_school 字串 學歷自填 國立交通大學
optional_school_status 指定字串 "學歷自填" 隱私狀態: Public (顯示), Private (隱藏) Public Private
interests 字串 興趣 電腦網路,聊天哈拉,唱歌跳舞
interests_status 指定字串 "興趣" 隱私狀態: Public (顯示), Private (隱藏) Public Private
optional_interests 字串 興趣自填 公益活動
optional_interests_status 指定字串 "興趣自填" 隱私狀態: Public (顯示), Private (隱藏) Public Private
likes 字串 喜歡的 知心朋友
likes_status 指定字串 "喜歡的" 隱私狀態: Public (顯示), Private (隱藏) Public Private
dislikes 字串 討厭的 族群對立
dislikes_status 指定字串 "討厭的" 隱私狀態: Public (顯示), Private (隱藏) Public Private
email 字串 Email username@yahoo.com
email_status 指定字串 "Email" 隱私狀態: Public (顯示), Private (隱藏) Public Private
msn 字串 MSN 帳號 username@hotmail.com
msn_status 指定字串 "MSN 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
yim 字串 YIM 帳號 username
yim_status 指定字串 "YIM 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
qq 字串 QQ 帳號 username
qq_status 指定字串 "QQ 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
aim 字串 AIM 帳號 username
aim_status 指定字串 "AIM 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
google 字串 Google Talk 帳號 username
google_status 指定字串 "Google Talk 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
skype 字串 Skype 帳號 username
skype_status 指定字串 "Skype 帳號" 隱私狀態: Public (顯示), Private (隱藏) Public Private
lang 指定字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得使用者大頭貼圖片路徑

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/profileService/{guid|wid}/cover

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch ID) 3FH7YZZWCUXHOQJNY6AQZPGDOI 或 wretchuser

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/profileService/6GEBDOA3NFVOOXL5TZVBDGNZNI/cover?format=xml

http://wretch.yahooapis.com/v1.2/profileService/openapi01/cover?format=xml

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
small URL 字串 大頭貼小型圖片網址 http://l.yimg.com/e/cover/wretchuser_60.jpg?25
medium URL 字串 大頭貼中型圖片網址 http://l.yimg.com/e/cover/wretchuser_90.jpg?25
large URL 字串 大頭貼大型圖片網址 http://l.yimg.com/e/cover/wretchuser_150.jpg?25
origin URL 字串 大頭貼原始圖片網址 http://l.yimg.com/e/cover/wretchuser.jpg?25
nickname 字串 使用者暱稱 無名正妹
lang 特定字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得指定的使用者的影音列表. 類似 http://www.wretch.cc/video/{wid}&func=d_list&view=list&o=time_d 的功能.

回應的內容會依照訪客的身分而有所不同.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/videoService/{guid|wid}/videos

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 筆,最多 20 筆 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/videoService/6GEBDOA3NFVOOXL5TZVBDGNZNI/videos?start=1&count=10

http://wretch.yahooapis.com/v1.2/videoService/openapi01/videos?start=1&count=10

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
video_id 正整數 影片編號 6023105
title 字串 影片標題 神祕經典
length 正整數 影片長度, 單位是秒 62
description 字串 影片敘述 Mo~~~
post_time 日期字串 影片發表時間 (年-月-日 時:分:秒) 2011-01-19 15:12:45
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Public
site_category_id 正整數 全站分類編號
site_category_name 字串 全站分類
user_category_id 正整數 個人分類編號
user_category_name 字串 個人分類
total_counter 正整數 瀏覽 0 0
total_comment 正整數 回應 0 0
total_trackback 正整數 引用 0 0
total_collection 正整數 收藏 0 0
thumb_url 網址 影片縮圖網址
url 網址 單一影片的網頁網址
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

上傳一則影音. 類似 http://www.wretch.cc/video/yuiuploader.php 的功能.

關於 friend_group, 在網頁上的行為是在沒有好友群組的時候會讓你選 0, 也就是開放給所有好友. 但是在有好友群組的時候, 下拉選單就不再有這個選項可以選. 目前的決定是, 在 API 裡面使用者永遠都有 0 可以選擇.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/videoService/{guid|wid}/videos

通訊方式 (HTTP Method)

POST

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01

以下參數必須以 "XML的格式" 帶在 "Content" 中
參數名稱 是否必填 參數型態 說明 預設值 範例
content 圖片檔案內容 以 Base64 編碼後的影音內容
title 字串 影片標題
神祕經典
description 字串 影片敘述
Mo~~~
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Public
Public
key 字串 通關密碼. 只有在保護方式是 Password_Protected 的時候此參數才有意義,key 至少五個字數,且需同時包含英文字母與數字
25th-April
key_note 字串 通關密碼提示
我的生日
friend_group 正整數 好友保護的群組編號. 只有在保護方式是 Friend_only 的時候此參數才有意義. 預設是開放給所有好友. 0
0
site_category_id 正整數 全站分類編號
user_category_id 正整數 個人分類編號 0
allow_comment 指定字串 回應權限: wide_open, Members_Only, Friends_Only, No_one wide_open
book_id 正整數 相簿編號
1
quality 指定數字 上傳品質: 0 (最佳品質), 1 (標準), 2 (最省空間) 1
3

需求範例 (Request Example)

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
video_id 正整數 影音編號 6023105
thumb_url 網址 影音縮圖網址 http://f5.wretch.yimg.com/wretchoffice/79/thumbs/t1945049351.jpg?mvAxh55DfRLmGMKl4lR6OsvIw_sq2Y7Tn58rn58SnFFab2ur.6p77husVRD_uOiPWa.rwIY-
url 網址 影音網址 http://116.214.13.48/wretchoffice/79/1945049351.flv
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得指定的影音. 類似 http://www.wretch.cc/video/{wid}&func=single&vid={video_id} 的功能.

回應的內容會依照訪客的身分而有所不同.

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/videoService/{guid|wid}/video/{video_id}

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
video_id 正整數 影音編號 6023105

需求範例 (Request Example)

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
title 字串 影片標題 神祕經典
length 正整數 影片長度, 單位是秒 62
description 字串 影片敘述 Mo~~~
post_time 日期字串 影片發表時間 (年-月-日 時:分:秒) 2011-01-19 15:12:45
status 指定字串 保護方式: Public(公開), Private(隱藏), Password_Protected(通關密碼), Friends_Only(好友保護) Public
site_category_id 正整數 全站分類編號
site_category_name 字串 全站分類
user_category_id 正整數 個人分類編號
user_category_name 字串 個人分類
total_counter 正整數 瀏覽 0 0
total_comment 正整數 回應 0 0
total_trackback 正整數 引用 0 0
total_collection 正整數 收藏 0 0
thumb_url 網址 影片縮圖網址
url 網址 影片檔案的網址, 也就是 flash player 背後的 .flv 檔案
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得此使用者設為好友的列表功能.

取得此使用者的 '我的好友'

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/friendService/{guid|wid}/friends

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 筆,最多 20 筆 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/friendService/6GEBDOA3NFVOOXL5TZVBDGNZNI/friends
or
http://wretch.yahooapis.com/v1.2/friendService/openapi01/friends

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
friend_userid 字串 好友無名帳號 openapi07
friend_url 字串 該無名帳號的好友URL http://www.wretch.cc/friend/openapi07
cover_url 字串 大頭貼中型圖片網址 http://cover.wretch.cc/openapi07_90.jpg?0
status 指定字串 好友狀態: Public(公開), Private(隱藏) Private
friend_group 字串 好友類別 大學同學
description 字串 好友描述 宅男,目前單身,無不良嗜好
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得此使用者互為好友的列表功能.

取得此使用者的'互為好友'列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/friendService/{guid|wid}/mutualFriends

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 筆,最多 20 筆 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/friendService/6GEBDOA3NFVOOXL5TZVBDGNZNI/mutualFriends
or
http://wretch.yahooapis.com/v1.2/friendService/openapi01/mutualFriends

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
friend_userid 字串 好友無名帳號 openapi07
friend_url 字串 該無名帳號的好友URL http://www.wretch.cc/friend/openapi07
cover_url 字串 大頭貼中型圖片網址 http://cover.wretch.cc/openapi07_90.jpg?0
description 字串 好友描述 宅男,目前單身,無不良嗜好
friend_group 字串 好友類別 大學同學
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得此使用者加為好友的列表功能.

取得此使用者的'加為好友'列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/friendService/{guid|wid}/reverseFriends

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
guid 或 wid 字串 使用者的 GUID 或無名帳號 (Wretch id) 6GEBDOA3NFVOOXL5TZVBDGNZNI 或 openapi01
start 正整數 從第幾筆開始抓取 1 1
count 正整數 回傳筆數,預設 20 筆,最多 20 筆 20 20

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/friendService/6GEBDOA3NFVOOXL5TZVBDGNZNI/reverseFriends
or
http://wretch.yahooapis.com/v1.2/friendService/openapi01/reverseFriends

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
friend_userid 字串 好友無名帳號 openapi07
friend_url 字串 該無名帳號的好友URL http://www.wretch.cc/friend/openapi07
cover_url 字串 大頭貼中型圖片網址 http://cover.wretch.cc/openapi07_90.jpg?0
description 字串 好友描述 宅男,目前單身,無不良嗜好
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得相簿全站分類列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/siteAlbumCategories

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/siteAlbumCategories

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
category_id 正整數 分類編號 112
description 字串 分類描述 美食記錄(餐廳、小吃、咖啡館、烹飪)
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得相簿全站分類列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/siteVideoCategories

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/siteVideoCategories

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
category_id 正整數 分類編號 2
description 字串 分類描述 國內旅遊(台灣本島、離島、其他)
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

功能說明 (Detail)

取得網誌全站分類列表

連接網址 (URL)

http://wretch.yahooapis.com/v1.2/siteBlogCategories

通訊方式 (HTTP Method)

GET

需求參數 (Request Parameters)

需求範例 (Request Example)

http://wretch.yahooapis.com/v1.2/siteBlogCategories

回應參數 (Response Parameters)

參數名稱 是否必填 參數型態 說明 預設值 範例
category_id_layer1 正整數 第一層分類編號 52
category_id_layer2 正整數 第二層分類編號 20
category_id_layer3 正整數 第三層分類編號 229
description_layer1 字串 第一層分類描述 心情
description_layer2 字串 第二層分類描述 個人
description_layer3 字串 第三層分類描述 心情小語
lang 字串 語系 zh-Hant-TW zh-Hant-TW

回應範例 (Response Example)

工具與實作參考

  • ASTRA

    ASTRA 是一個 ActionScript 的 RIA 工具包,有許多由 Yahoo! 所開發的 Flash 與 Flex 的元件、函式庫、工具包、控制項,方便給 ActionScript 的開發者使用。

  • 設計模式

    常用模組的互動設計模式參考,提昇您網站的可用性。

  • 效能處理

    改進網站效能的實作原則,內容包含了實驗結果與測試工具,讓您可以依據這些實作原則建立起高效能的網站。

  • 網路安全

    網路安全的實作原則與規定,讓使用者相信您所撰寫的應用程式並受到保護。

  • YUI 使用者函式庫

    YUI 提供製作 Web 2.0 網站所需的 JavaScript 相關功能與控制項,更提供了 CSS 的解決方案。除了符合前端快速開發的要求,更是一個最專業、文件最齊全的函式庫。