Json protocol, Geo2tag REST API fundamentals
1 like681 views
The document describes a RESTful JSON API for a geo-tagging application called Geo2tag. It outlines the goals of REST, defines JSON and its grammar, provides API usage examples using cURL, and details the API endpoints for user management, channel management, and working with geo tags. The API uses HTTP requests, JSON payloads, and authentication tokens to allow clients to interact with the Geo2tag service in a stateless and scalable way.
![Grammar
● Begin-array – [ left square bracket
● Begin-object – { left curly bracket
● End-array – ] right square bracket
● End-object – } right curly bracket
● Name-separator – : colon
● Value-separator – ; , comma
5
India, Feb 2013](https://image.slidesharecdn.com/json-protocol-130221232757-phpapp01/85/Json-protocol-Geo2tag-REST-API-fundamentals-5-320.jpg)
![Examples
{
"Image": {
"Width": 800,
"Height": 600,
"Title": "View from 15th Floor",
"Thumbnail": {
"Url": "http://www.example.com/image/481989943",
"Height": 125,
"Width": "100"
},
"IDs": [116, 943, 234, 38793]
}
6
India, Feb 2013](https://image.slidesharecdn.com/json-protocol-130221232757-phpapp01/85/Json-protocol-Geo2tag-REST-API-fundamentals-6-320.jpg)
Json protocol, Geo2tag REST API fundamentals
- 1. REST, JSON APIs Geo2tag interface description 1 India, Feb 2013
- 2. RESTful API ● REST = Representational State Transfer – 2000 by Roy Fielding – The model of http (v 1.0) – HTTP POST is being used for communication. 2 India, Feb 2013
- 3. Goals of REST ● Scalability of component interactions ● Generality of interfaces ● Independent deployment of components ● encapsulate legacy systems 3 India, Feb 2013
- 4. Java script Object Notation ● Text-based, Object-oriented, data interchange format. ● Structure: – A collection of name/value pairs – Ordered list of values. 4 India, Feb 2013
- 5. Grammar ● Begin-array – [ left square bracket ● Begin-object – { left curly bracket ● End-array – ] right square bracket ● End-object – } right curly bracket ● Name-separator – : colon ● Value-separator – ; , comma 5 India, Feb 2013
- 6. Examples { "Image": { "Width": 800, "Height": 600, "Title": "View from 15th Floor", "Thumbnail": { "Url": "http://www.example.com/image/481989943", "Height": 125, "Width": "100" }, "IDs": [116, 943, 234, 38793] } 6 India, Feb 2013
- 7. Geo2tag REST API Based on JSON objects interchange ● Command: – URI ● Service URL ● Function – Parameters: JSON object Example URI http://india.geo2tag.org/service/login – Params (Json): '{"login":"Mark","password":"test"} 7 India, Feb 2013
- 8. Invoking by curl $ curl -d '{"login":"Mark","password":"test"}' http://india.geo2tag.org/service/login 8 India, Feb 2013
- 9. Session token client server /version {“errno”: 0, “version” : “1.02”} /login {“login” : “user”, “password”:”pwd”} {“errno”: 0, “auth_token” : “765888876588”} /loadTags {“auth_token” : “765888876588”, “latitude”:23.0, ”longitude”:12.0, “radius”: 5} {“errno”: 0, ...} 9 India, Feb 2013
- 10. Live example 10 India, Feb 2013
- 11. Command security ● Plain commands (version, build,...) ● Session management – login – closeSession ● Authorized commands – With session token 11 India, Feb 2013
- 12. Session workflow ● Check version ● Acquire session token ● … R/W tags, channels ● Close session 12 India, Feb 2013
- 13. Login ● /login – login – password 13 India, Feb 2013
- 14. User management ● /addUser – login – password – Email ● /deleteUser – login 14 India, Feb 2013
- 15. Channel Management ● /addChannel – name – description – url – radius ● /owned ● /subscribe ● /subscribed 15 India, Feb 2013
- 16. Working with tags ● /writeTag – channel – description – {coordinates} – time – title ● /loadTags – latitude – longitude – radius – 16 India, Feb 2013
- 17. Contacts geo2tag-maintainer@fruct.org 17 India, Feb 2013