Difference between revisions of "YTMND:API:Interfaces"

From YTMND
Jump to: navigation, search
Line 1: Line 1:
 
==Sites==
 
==Sites==
 +
===Example request===
 +
http://api.ytmnd.com/sites/tomarnoldjungle
  
−
==Users==
+
===Example responses===
  
 +
====XML====
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<ytmnd_response timestamp="2007-10-14T00:57:48-05:00" request_type="site" extended_request="basic" returned_results="1">
 +
  <sites>
 +
  <site site_id="801024" domain="tomarnoldjungle" created="2007-08-15T01:47:04-05:00" modified="2007-08-15T14:28:41-05:00" classic_ytmnd="false">
 +
    <user user_id="111682" user_name="BTape"/>
 +
    <title>Tom Arnold Lost His Way In The Peruvian Jungle</title>
 +
    <description>Tom Arnold got off the tour to get coffee... at the only place without a Starbucks.</description>
 +
    <keywords>tom arnold, jungle</keywords>
 +
    <site_text line_1="" line_2="" line_3="" image_text="false"/>
 +
    <display_options background_color="1E3910" image_placement="center" synchronize="true" delay="0"/>
 +
    <image_origin>http://tom-arnold.ytmnd.com/ + various</image_origin>
 +
    <sound_origin>RJD2 - Ring Finger, various</sound_origin>
 +
    <moderated work_safe="true"/>
 +
    <assets>
 +
    <asset type="thumb" asset_id="2427953" kilobytes="6" url="http://content.ytmnd.com/content/7/8/1/78155565973df3f223361eea4c5ba808.jpg"/>
 +
    </assets>
 +
    <score computed_score="3.7574" total_votes="202" vote_sum="759" score_image="stars_red_38.gif"/>
 +
    <site_views today="0" yesterday="7" week="62" month="177" all_time="2922"/>
 +
  </site>
 +
  </sites>
 +
</ytmnd_response>
 +
 +
====JSON====
 +
{
 +
  "timestamp":"2007-10-14T01:00:50-05:00",
 +
  "request_type":"site",
 +
  "extended_request":"basic",
 +
  "returned_results":1,
 +
  "sites":
 +
  {
 +
  "801024":
 +
  {
 +
    "site_id":"801024",
 +
    "domain":"tomarnoldjungle",
 +
    "created":"2007-08-15T01:47:04-05:00",
 +
    "modified":"2007-08-15T14:28:41-05:00",
 +
    "classic_ytmnd":false,
 +
    "user":
 +
    {
 +
    "user_id":"111682",
 +
    "user_name":"BTape"
 +
    },
 +
    "title":"Tom Arnold Lost His Way In The Peruvian Jungle",
 +
    "description":"Tom Arnold got off the tour to get coffee... at the only place without a Starbucks.",
 +
    "keywords":"tom arnold,jungle",
 +
    "site_text":
 +
    {
 +
    "line_1":"",
 +
    "line_2":"",
 +
    "line_3":"",
 +
    "image_text":false
 +
    },
 +
    "display_options":
 +
    {
 +
    "background_color":"1E3910",
 +
    "image_placement":"center",
 +
    "synchronize":true,
 +
    "delay":0
 +
    },
 +
    "image_origin":"http:\/\/tom-arnold.ytmnd.com\/ + various",
 +
    "sound_origin":"RJD2 - Ring Finger, various",
 +
    "moderated":
 +
    {
 +
    "work_safe":true
 +
    },
 +
    "assets":
 +
    {
 +
    "2427953":
 +
    {
 +
      "type":"thumb",
 +
      "asset_id":"2427953",
 +
      "kilobytes":"6",
 +
      "url":"http:\/\/content.ytmnd.com\/content\/7\/8\/1\/78155565973df3f223361eea4c5ba808.jpg"
 +
    }
 +
    },
 +
    "score":
 +
    {
 +
    "computed_score":3.7574,
 +
    "total_votes":"202",
 +
    "vote_sum":"759",
 +
    "score_image":"stars_red_38.gif"},
 +
    "site_views":
 +
    {
 +
      "today":0,
 +
      "yesterday":7,
 +
      "week":62,
 +
      "month":177,
 +
      "all_time":2922
 +
    }
 +
    }
 +
  }
 +
}
 +
 +
====PHP====
 +
 +
 +
==Users==
 
===Example request===
 
===Example request===
 
  http://api.ytmnd.com/user/max
 
  http://api.ytmnd.com/user/max
Line 67: Line 167:
 
GET /user/{user name}/recent_sites
 
GET /user/{user name}/recent_sites
 
*Named user's 5 most recent sites.
 
*Named user's 5 most recent sites.
 +
GET /user/{user name}/recent_comments
 +
*Named user's 5 most recent comments.

Revision as of 00:16, October 14, 2007

Sites

Example request

http://api.ytmnd.com/sites/tomarnoldjungle

Example responses

XML

<?xml version="1.0" encoding="UTF-8"?>
<ytmnd_response timestamp="2007-10-14T00:57:48-05:00" request_type="site" extended_request="basic" returned_results="1">
 <sites>
  <site site_id="801024" domain="tomarnoldjungle" created="2007-08-15T01:47:04-05:00" modified="2007-08-15T14:28:41-05:00" classic_ytmnd="false">
   <user user_id="111682" user_name="BTape"/>
   <title>Tom Arnold Lost His Way In The Peruvian Jungle</title>
   <description>Tom Arnold got off the tour to get coffee... at the only place without a Starbucks.</description>
   <keywords>tom arnold, jungle</keywords>
   <site_text line_1="" line_2="" line_3="" image_text="false"/>
   <display_options background_color="1E3910" image_placement="center" synchronize="true" delay="0"/>
   <image_origin>http://tom-arnold.ytmnd.com/ + various</image_origin>
   <sound_origin>RJD2 - Ring Finger, various</sound_origin>
   <moderated work_safe="true"/>
   <assets>
    <asset type="thumb" asset_id="2427953" kilobytes="6" url="http://content.ytmnd.com/content/7/8/1/78155565973df3f223361eea4c5ba808.jpg"/>
   </assets>
   <score computed_score="3.7574" total_votes="202" vote_sum="759" score_image="stars_red_38.gif"/>
   <site_views today="0" yesterday="7" week="62" month="177" all_time="2922"/>
  </site>
 </sites>
</ytmnd_response>

JSON

{
 "timestamp":"2007-10-14T01:00:50-05:00",
 "request_type":"site",
 "extended_request":"basic",
 "returned_results":1,
 "sites":
 {
  "801024":
  {
   "site_id":"801024",
   "domain":"tomarnoldjungle",
   "created":"2007-08-15T01:47:04-05:00",
   "modified":"2007-08-15T14:28:41-05:00",
   "classic_ytmnd":false,
   "user":
   {
    "user_id":"111682",
    "user_name":"BTape"
   },
   "title":"Tom Arnold Lost His Way In The Peruvian Jungle",
   "description":"Tom Arnold got off the tour to get coffee... at the only place without a Starbucks.",
   "keywords":"tom arnold,jungle",
   "site_text":
   {
    "line_1":"",
    "line_2":"",
    "line_3":"",
    "image_text":false
   },
   "display_options":
   {
    "background_color":"1E3910",
    "image_placement":"center",
    "synchronize":true,
    "delay":0
   },
   "image_origin":"http:\/\/tom-arnold.ytmnd.com\/ + various",
   "sound_origin":"RJD2 - Ring Finger, various",
   "moderated":
   {
    "work_safe":true
   },
   "assets":
   {
    "2427953":
    {
     "type":"thumb",
     "asset_id":"2427953",
     "kilobytes":"6",
     "url":"http:\/\/content.ytmnd.com\/content\/7\/8\/1\/78155565973df3f223361eea4c5ba808.jpg"
    }
   },
   "score":
   {
    "computed_score":3.7574,
    "total_votes":"202",
    "vote_sum":"759",
    "score_image":"stars_red_38.gif"},
    "site_views":
    {
     "today":0,
     "yesterday":7,
     "week":62,
     "month":177,
     "all_time":2922
    }
   }
 }
}

PHP

Users

Example request

http://api.ytmnd.com/user/max

Example responses

XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<ytmnd_response timestamp="1192340109" request_type="user_lookup" extended_request="basic" returned_results="1">
  <users>
    <user user_id="1" signup_date="1081312566" user_name="max" />
  </users>
</ytmnd_response>

JSON

{
 "timestamp":1192340298,
 "request_type":"user_lookup",
 "extended_request":"basic",
 "returned_results":1,
 "users":
 {
  "1":
  {
   "signup_date":"1081312566",
   "user_name":"max",
   "user_id":"1"
  }
 }
}

PHP

a:5:
{
 s:9:"timestamp";
 i:1192340492;
 s:12:"request_type";
 s:11:"user_lookup";
 s:16:"extended_request";
 s:5:"basic";
 s:16:"returned_results";
 i:1;
 s:5:"users";
 a:1:
 {
  i:1;
  a:3:
  {
   s:11:"signup_date";
   s:10:"1081312566";
   s:9:"user_name";
   s:3:"max";
   s:7:"user_id";
   s:1:"1";
  }
 }
}

Endpoints

GET /user/{user name}

  • Named user.

GET /user/{user name}/all_sites

  • All of named user's sites.

GET /user/{user name}/recent_sites

  • Named user's 5 most recent sites.

GET /user/{user name}/recent_comments

  • Named user's 5 most recent comments.
Retrieved from "http://wiki.ytmnd.net/index.php?title=YTMND:API:Interfaces&oldid=37503"