Developer's section : walk2web API

To start using our visualization system You should do the next steps:

1. Develop your scripts that will provide needed info for our utility.

2. Insert our flash into your page/site.

All queries to the scripts looks like http://site/script?parameters or http://site/dir/file
(the second type queries can be redirected to scripts using mod_rewrite or by some other handy for you method)

1. Params description for your scripts:

Attention: All MIME types for server answers should be set correctly.

1.1. Update image for the object with needed object identifier.

?do=update_shot&id=ObjectID
Response: no

1.2. Audio file query for the needed object

?do=speak_title&id=ObjectID
Return value: mp3 stream

1.3. Object info query (tags, comments, title)

?do=site_info&id=ObjectID

Response: XML

1.4. Query for file name of the CAPTCHA image file

?do=register

Response: Plain text

1.5. Query for the image file of CAPTCHA (got the FILENAME by 1.4 query)

/snap/captcha/FILENAME.gif

1.6. Query for user registration

/?do=register&email=user_email&login=user_login&password=user_password&captcha=user_security_input&captcha_id=security_id

user_email – user’s email

user_login – user’s login name

user_password – user’s password

user_security_input – CAPTCHA parameter (users input)

security_id – security file id

Response: error list or nothing

1.7. Query for Object info and the list of dependent nodes.

/snap/xml/sub_defined_identifier.xml

sub_defined_identifier - to optimize file system for big numbers of nodes, we convert identifiers of nodes by this algorithm: 12345678 --> 678/345/12

It returns not bigger then 5 IN and 5 OUT sub-nodes. For another nodes, please check 1.7.2

Response: XML

1.7.1. Background query for sub-nodes of needed node.

/snap/xml/sub_defined_identifier .xml?level=2

It differs from 1.7 by less priority for the server.

Also, sub-nodes that was received by this method is not shown till the opening of the node, but node info is being stored in the flash, so on click - user gets result immediately without getting data from server.

1.7.2. Query for number of sub-nodes for needed node with needed shift (It's used on "More" opening)

/snap/xml/sub_defined_identifier/direction/shift-number_of_sub_nodes.xml

direction (in or out) - it's for getting needed types of sub-nodes

shift - it's the serial number of the node from which we want to get sub-nodes list

number_of_sub_nodes - the number of sub-nodes we want to receieve

1.8. 400х300 image query (it's showed on the screen in the upper right corner)

/snap/sub_defined_identifier.400.jpg

Response: JPEG

1.9. 120х90 image query (it's showed when mouse is over the node)

/snap/sub_defined_identifier.120.jpg

Response: JPEG

Appendix to 1.7.

Information about the nodes and sub-nodes example:

</branch>

Description of this info:

emotion - emotions associated with this node. 0 - no emotions, 1 - good node, 2 - bad node, 3 - spam.

nRating - negative rating

pRating - positive rating

parent - node identfier (requested data was made for this node)

title - title of this node

outqty - outgoing sub-nodes quantity

inqty - incoming subnodes quantity

type - node type. This is a string that handles some information in every symbol of it.

First symbol - is it in bookmarks or not: 0 - not in bookmarks, 1 - in bookmarks

The second symbol - rate that current user set to node: 0 - no rate, 1 - good, 2 - bad

The third - emotion: 0 - no, 1 - good, 2 - bad, 3 - spam

The fourth - node type: 0 - incoming, 1 - outgoing.

<comments qty="2">Gerous: Its the Domain from This ;) anonymous: cool thing you made!</comments>

Comments.

qty - the full number of comments (Tag shows only first five)

Simplified HTML can be used in comments, but all system symbols should be changed to html entities, as in example:

Decription of sub-node:

nid - identifier of sub-node

dir - node direction - input or output direction (values: in,out)

url - URL of the node (this text will be showed under the node on the screen, visible area has limitation).

<tags>111 123 browse cool design download enjoy fun google humor internet search site soft surf test test1 test3 video walk web</tags>

Content of this tag is showed in "Tags" field, simplified HTML can be used here

</branch>

Appendix to 1.3.

Node information example:

gedeon: You can also make card-to-card money transfers. It's cheaper than Western Union!

gedeon: Guys! Use this website to accept credit cards for free. All fees are paid

by your customers.

vityaz: test

nick: The best free service of supporting your clients on your site, make consulting

services and get paid for them.

</comments>

<tags>

accept card chat cool credit help

</tags>

</node>

Node explanation:

id - identifier of the node

title - title of the node

Other information is described in 1.7

2. Insert Flash to your page/site.

The start point additional object information is needed to insert flash into your page.

Additional info inserts using flashVars params (the standart method for inserting data from html to flash).

For different browsers and flash player versions compability it's recomended to insert swf-file using scripts:

Example:

getSWFHTML("/itrain3_3gray2.swf","train","high","#cccccc","100%","100%","t","noscale","transparent",'HOME_ID=226353&HOME_TITLE=Apple&HOME_GOOD_RATING=0&HOME_BAD_RATING=0&HOME_NODE_TYPE=000&HOME_URL=http://apple.com&HOME_EMOTION=0&SITES_TOTAL=1&TIME_TOTAL=143&AUTO=1')

</script>

Description:

getSWFHTML("PathToTheSWF","Tag ID","Quality","Background color","Width","Height","Align","Scale","Background transparency",

HOME_ID=start node ID

HOME_TITLE=start node title

HOME_GOOD_RATING=starting node positive rating points

HOME_BAD_RATING=starting node negative rating points

HOME_NODE_TYPE=start point type

HOME_URL=URL of start poinf

USER_NAME=username (if signed in)

HOME_EMOTION=emotions of stating node

SITES_TOTAL=The numbed of nodes, that user visited

TIME_TOTAL=total time that user wasted by walking on the flash

AUTO=1 (if autopilot is enabled) or do ignore this param in standart way

)