source: subversion/sites/other/ranaShareServer/readme.txt @ 10450

Last change on this file since 10450 was 8656, checked in by ojw, 11 years ago

add some documentation

File size: 1.3 KB
Line 
1Concepts:
2
3To create a user account on the server, specify a PIN that will be your password, and it will return a user ID.
4
5To create a group, specify the name, and two PINs:
6 * read PIN - anyone who knows this will be able to view the position of people in the group
7 * write PIN - anyone who knows this will be able to publish their position info on the group
8
9To make a group public, set read PIN to 0
10
11To upload your position, send your own ID/PIN, the group number to publish to, and the group's write PIN.  You must pubish "to a group" (create one if necessary)
12
13To set your nickname within a group, send your own ID/PIN, the group number this nickname applies to, and the group's write PIN.  So you can publish to several groups using several identities, using the same user account.
14
15To download a group, send the group number and the group's read PIN.  It will return a list of User,Lat,Lon.  Currently this returns user IDs, but it should return nicknames only.
16
17That is all. Enjoy.  Future concepts are in roadmap.txt.  API is best explored by going to the website and playing with the HTTP requests used by the forms:
18
19http://dev.openstreetmap.org/~ojw/pos/
20
21
22Install guide: just put into a website with PHP, modify the line which includes connect.php so that it connects to your MySQL database, and use the attached schema.sql to generate the blank database.
Note: See TracBrowser for help on using the repository browser.