-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathparams.json
1 lines (1 loc) · 4.02 KB
/
params.json
1
{"name":"Recognize.github.io","tagline":"","body":"# Recognize Api Summary\r\nThe Recognize api provides the following: \r\n+ Basic access to user profile information.\r\n+ Ability to view a users recognitions\r\n+ Send recognitions on behalf of a user\r\n+ Approve (+1 a recognition), or \"unapprove\" (removing a +1 from a recognition) a recognition.\r\n\r\nUsers authenticate access for each application using the 2-legged OAuth flow.\r\n\r\n## Base Endpoint\r\nhttp://recognizeapp.com/api/v1/\r\n\r\n## Endpoint overview\r\n GET /status # Check authentication status\r\n GET /recognitions # Get all recognitions for your company\r\n GET /[email protected] # Get all recognitions for a user\r\n GET /recognitions/new # Returns a url to fetch html for send recognition form\r\n POST /recognitions/:slug/approvals # +1(approve) a recognition\r\n DELETE /recognitions/:slug/approvals # Remove the +1 for a recognition\r\n GET /badge/:badge_id # Get more detailed information on a badge\r\n \r\n### Authentication Example in Ruby\r\n\r\n require 'oauth2'\r\n redirect_uri = \"http://yoursite.com/auth/recognize/callback\"\r\n client = OAuth2::Client.new(<APPLICATION_ID>, <APPLICATION_SECRET>, site: \"https://recognizeapp.com\")\r\n client.auth_code.authorize_url(:redirect_uri => redirect_uri)\r\n\r\nVisit authorize url in a browser and follow the flow until you get sent to your callback url.\r\nFind authorization code in url for next step.\r\n\r\n token = client.auth_code.get_token(<authorization_code>, redirect_uri: redirect_uri).\r\n\r\nVisit:\r\n\r\n https://recognizeapp.com/api/v1/ping?access_token=<token>\r\n\r\nAccess token can also be sent as a header:\r\n\r\n Authorization: Bearer <token>\r\n\r\n### Users (Path: /users)\r\n\r\n /users\r\n\r\n {\r\n \"users\": [\r\n {\r\n \"id\": 2,\r\n \"email\": \"[email protected]\",\r\n \"first_name\": \"Alex\",\r\n \"last_name\": \"Grande\",\r\n \"full_name\": \"Alex Grande\",\r\n \"company_name\": \"Recognizeapp\",\r\n \"yammer_id\": \"1489441844\",\r\n \"avatar_thumb_url\": \"\\/uploads\\/development\\/avatar_attachment\\/9517\\/file\\/thumb_avatar.jpg\"\r\n }\r\n ]\r\n }\r\n### Recognitions (Path: /recognitions)\r\n\r\n /recognitions\r\n\r\n {\r\n \"recognitions\": [\r\n {\r\n \"id\": 11367,\r\n \"message\": \"For showing leadership in starting recognition.\",\r\n \"slug\": \"17pr8evjcp9\",\r\n \"created_at\": \"2014-05-20 12:45:07 -0700\",\r\n \"badge_name\": \"Ambassador\",\r\n \"badge_permalink\": \"\\/uploads\\/development\\/badge\\/32\\/image\\/large_thumb_ambassador.png\",\r\n \"recipients\": [\r\n {\r\n \"id\": 11667,\r\n \"email\": \"[email protected]\",\r\n \"first_name\": \"Peter\",\r\n \"last_name\": \"Philips\",\r\n \"full_name\": \"Peter Philips\",\r\n \"company_name\": \"Ad Recognizeapp\",\r\n \"avatar_thumb_url\": \"\\/assets\\/icons\\/user-default.png\",\r\n \"yammer_id\": \"\"\r\n }\r\n ],\r\n \"approvers\": [\r\n \r\n ],\r\n \"sender\": {\r\n \"id\": 1,\r\n \"email\": \"[email protected]\",\r\n \"first_name\": \"Recognize\",\r\n \"last_name\": \"Team\",\r\n \"full_name\": \"Recognize Team\",\r\n \"company_name\": \"Recognizeapp\",\r\n \"yammer_id\": \"\",\r\n \"avatar_thumb_url\": \"\\/uploads\\/development\\/avatar_attachment\\/33\\/file\\/thumb_logo_180x180.png\"\r\n },\r\n \"permalink\": \"http:\\/\\/localhost:3000\\/recognitions\\/17pr8evjcp9\",\r\n \"system_recognition?\": \"true\",\r\n \"friendly_created_at\": \"about 10 hours ago\",\r\n \"approvals_count\": 0\r\n },\r\n }\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}