Introduction to Messenger APIs at Yahoo! Open Hack Europe 2011

3. URIs, URI parameters, and URL encoding

4. Request / Response Headers

5. HTTP content

6. RESTful

7. APIs use HTTP GET, POST, and the less common PUT, DELETE

8. Override using HTTP POST and URI parameter “_method=[put,delete]”

9. JSON

10. No XML support

12. Direct Oauth

13. Consumer key must have read/write access for Y! Messenger

14. Programmatic authentication

15. No browser

16. Other mobile integration friendly optimizations

17. Accuracy of timestamp restriction is relaxed if you use PLAINTEXT oauth signature

19. Client to Server communication (typically user actions)

20. Send an instant message

21. Login into messenger

22. Server to Client communication (… but client initiated)

23. Someone send you an instant message

25. Login (POST /session)

26. Dynamic capabilities (mailAlerts/fileXfer/buzz/smiley) per login session

27. Supply presence information at login

28. Get back the contact or group list in the response

29. Look for the URI parameter ‘fieldsBuddyList’ or ‘fieldsGroupList’

30. Logout (DELETE /session)

31. Keepalive (PUT /session/keepalive)

32. Client heartbeat

33. Presence Management

34. Update your presence information (PUT /presence)

35. State (available, busy, idle, invisible)

37. Instant Message (POST /message/{network}/{id})

38. No Interop (msn/hotmail/etc)

39. Contact/Group Management

40. Fetch your contact or group list

41. Now supports fetching a subset of your AddressBook data

42. Add a contact (PUT /group/{groupname}/contact/…)

44. An event targeted to a logged in session

45. Most common notification types

46. message

47. Typically an incoming instant message

48. buddyInfo

49. Information about a contact that just logged into messenger

50. Information about contacts online when you first login

51. buddyStatus

52. A buddy updated their presence information (state/custom message)

53. logoff

54. A buddy went offline

55. buddyAuthorize

56. Someone is trying to add you to their buddy list

58. All notifications have a sequence number unique to the session

59. Incremental integer

60. Unlikely, but design for skips in the sequence counter

61. Design to be able to skip unknown notification types

62. Retrieving Notifications

63. Periodic Polling

64. Provide start sequence number and optional count

65. Limited to under once every 5-10 seconds

66. Does not support persistent connections

67. Comet Style Push (Long Poll)

68. Provide start sequence number and optional idleTimeout

69. Expected that client will always maintain an available long poll

71. Send and Receive files

72. Remember to indicate ‘fileXfer’ clientCapability at login

73. Display Images

74. Upload and update your custom display image

76. Login (POST /session)

77. Request for groups list in the response

78. Look at URI parameter ‘fieldsGroupList’

79. Information about your buddies

80. Don’t request for information using Group or Contact List Management APIs

81. Wait for buddyInfo notifications for all online buddies

82. Automatically also subscribed for delta notifications (buddyStatus/logoff/etc)

83. Triggers any offline messages received

84. Look for offlineMessage notification type

85. < Other API calls. Don’t forget /keepalive >

87. Exchange UserId/Password for PART (HTTPS)

88. PART = Pre-Approved Request Token

89. Programmatic solution

90. Exchange PART for Access Token / Handle (HTTPS)

91. Date/Time issue on mobile devices

92. Accuracy requirement relaxed if you use PLAINTEXT oauth signature method

93. Access token expiration

94. Looking to extend this for Y! Messenger only consumer keys