Hyves - Always in touch with your friends

 
 
 
 
 

Data-API

Data-API

Methods

Create a gadget by XML url (OpenSocial gadgets).

  • Added: Sept 11, 2008
  • Paginated

params

  • specurl --- The specurl of the gadget.
    • Required
  • visibility --- The visibility of the gadget.
    • Required
    • Possible values:
      • friend --- visible only to the friends of the user.
      • friends_of_friends --- visible only to the friends of the user and their friends.
      • public --- visible only to all logged in hyvers.
      • superpublic --- visible only to all (whether logged in or not).
      • default --- default visibility, as presented to Hyver on website (note: may involve settings, not a static result).
  • onprofilepage --- Show gadget on profilepage.
    • Optional
    • Default: true
    • Possible values:
      • true --- true
      • false --- false
  • onhomepage --- Show gadget on the homepage.
    • Optional
    • Default: false
    • Possible values:
      • true --- true
      • false --- false

responsefields

This method supports the use of ha_responsefields. Acceptable values are a comma separated list of 0 or more of the following:
  • commentscount
  • respectscount
  • fancylayouttag
  • viewscount
  • hasrespected

extra

  • For this function to work, you need to supply a valid access token to oauth_token.
  • For more information on oAuth, see http://www.hyves-developers.nl/documentation/data-api/hyves-api-oauth/.
  • Please provide some kind of user feedback when an item is created.

    • examples

    example 1

    url
    https://data.hyves-api.nl/?oauth_token=YXRfMjY0MTQzOTE4X3pgNkF9lPAmdP62qYaw5dg%3D&specurl=http%3A%2F%2Fwww.apikooien.nl%2Fexamples%2Fopensocial%2Fhelloworld.xml&visibility=superpublic&onprofilepage=true&ha_method=gadgets.createByXML&oauth_consumer_key=Nl-SK2c5ZCBKB_I8hCF_zjPd&ha_version=2.0&oauth_signature_method=PLAINTEXT

    result
    •  <?xml version="1.0" encoding="UTF-8"?>
    •  <gadgets_createByXML_result>
    •   <gadget>
    •   <gadgetid>0090d583dd644f27ee7986c76acda2d8d5</gadgetid>
    •   <title>Hello world example</title>
    •   <html>&lt;div class=&quot;widget-container&quot;&gt;
    •   &lt;a href=&quot;http://panapi.hyves.nl/gapmember/18912758/Hello_world_example/3sPUOlcY/&quot;&gt;&lt;img src=&quot;/images/widgets/opensocial.gif&quot; class=&quot;inlineicon&quot; width=&quot;99&quot; height=&quot;100&quot; alt=&quot;&quot; &gt;&lt;/a&gt;&lt;/div&gt;</html>
    •   <specurl>http://www.apikooien.nl/examples/opensocial/helloworld.xml</specurl>
    •   <maycopy>true</maycopy>
    •   <userid>00086769082d53ad21952679a7238766db</userid>
    •   <url>http://panapi.hyves.nl/gapmember/18912758/Hello_world_example/3sPUOlcY/</url>
    •   <visibility>superpublic</visibility>
    •   </gadget>
    •   <info>
    •   <secure_connection>true</secure_connection>
    •   <running_milliseconds>64</running_milliseconds>
    •   <serverinfo>web991_stable_93882_HPHP</serverinfo>
    •   </info>
    •   </gadgets_createByXML_result>

    example 2

    url
    https://data.hyves-api.nl/?oauth_token=YXRfMjY0MTQzOTE4X3pgNkF9lPAmdP62qYaw5dg%3D&specurl=http%3A%2F%2Fwww.apikooien.nl%2Fexamples%2Fopensocial%2Fhelloworld.xml&visibility=superpublic&onprofilepage=true&ha_method=gadgets.createByXML&ha_responsefields=commentscount%2Crespectscount%2Cfancylayouttag%2Cviewscount%2Chasrespected&oauth_consumer_key=Nl-SK2c5ZCBKB_I8hCF_zjPd&ha_version=2.0&oauth_signature_method=PLAINTEXT

    result
    •  <?xml version="1.0" encoding="UTF-8"?>
    •  <gadgets_createByXML_result>
    •   <gadget>
    •   <gadgetid>0090d583dd644f27ee7986c76acda2d8d5</gadgetid>
    •   <title>Hello world example</title>
    •   <html>&lt;div class=&quot;widget-container&quot;&gt;
    •   &lt;a href=&quot;http://panapi.hyves.nl/gapmember/18912758/Hello_world_example/3sPUOlcY/&quot;&gt;&lt;img src=&quot;/images/widgets/opensocial.gif&quot; class=&quot;inlineicon&quot; width=&quot;99&quot; height=&quot;100&quot; alt=&quot;&quot; &gt;&lt;/a&gt;&lt;/div&gt;</html>
    •   <specurl>http://www.apikooien.nl/examples/opensocial/helloworld.xml</specurl>
    •   <maycopy>true</maycopy>
    •   <userid>00086769082d53ad21952679a7238766db</userid>
    •   <url>http://panapi.hyves.nl/gapmember/18912758/Hello_world_example/3sPUOlcY/</url>
    •   <visibility>superpublic</visibility>
    •   <commentscount>0</commentscount>
    •   <respectscount>0</respectscount>
    •   <hasrespected>false</hasrespected>
    •   <fancylayouttag>[gadget]&lt;div class=&quot;widget-container&quot;&gt;
    •   &lt;a href=&quot;http://panapi.hyves.nl/gapmember/18912758/Hello_world_example/3sPUOlcY/&quot;&gt;&lt;img src=&quot;/images/widgets/opensocial.gif&quot; class=&quot;inlineicon&quot; width=&quot;99&quot; height=&quot;100&quot; alt=&quot;&quot; &gt;&lt;/a&gt;&lt;/div&gt;[/gadget]</fancylayouttag>
    •   <viewscount/>
    •   </gadget>
    •   <info>
    •   <secure_connection>true</secure_connection>
    •   <running_milliseconds>48</running_milliseconds>
    •   <serverinfo>web1025_stable_93882_HPHP</serverinfo>
    •   </info>
    •   </gadgets_createByXML_result>

    Categories

    • gadgets

    © 2004-2012 Hyves   Algemene Gebruiksvoorwaarden   Je Privacy

    Aanmelden