forked from node-red/node-red
-
Notifications
You must be signed in to change notification settings - Fork 0
Web Nodes outline
hbeeken edited this page Oct 7, 2014
·
10 revisions
This is a list of web APIs we want to start creating nodes for.
For each service there are some thoughts of the types of input/query/output capabilities we might want. Some need further investigation to see what they expose in their API.
Some use HTTP(S) callback for event notification. This will only be possible with a public facing host e.g. bluemix. Some have alternative polling based apis which we can use.
- Input events require https callback. There is a URL which can be polled (although this isn't the recommended usage, it is ok for the first pass of the node).
- Their OAuth authentication implementation requires a predefined callback uri which cannot be overridden by the application. This makes it impossible to create an authentication flow as we've done for twitter/flickr. This has been fixed along the same lines as some of the other more recent nodes.
- API currently only supports polling check-in information of the authenticated user (https://developer.foursquare.com/docs/users/checkins - "self" is only supported). However, can get the list of friends for the authenticated user and then see which check-ins they've made so there may be a way around it. This needs clarification and looking into.
- New checkin for the authenticated user
- New checkin for another user
- New checkin from authenticated user's friends
Notes:
- Only return a new check-in since the node was initialized
- Polls every 15 mins
- Could consider adding additional filter options - tag, category, geographic region...
- Poll the check-in URI to get the list of check-ins for the authenticated user ('self')
- Poll the check-in URI to get the list of check-ins for a 'friend'
Notes:
- Always return the most recent check-in since the node was initialized.
- Create a checkin event
- Foursqure 8.0 split into Foursquare and Swarm. Foursquare being the "give me all the chinese restaurants near me" type capability and Swarm being the "check-in", more social capability (https://developer.foursquare.com/docs/2014update). Therefore anything check-in related needs to be named Swarm, as we have done.
- New file in a watched folder
- Get file contents
- Write to a file (replace/append)
- Need to review API to see what events we can monitor
- ... lots ...
- Status update
- Link share
- Upload photo to a specified album
https://github.com/node-red/node-red-web-nodes/tree/master/delicious
- ...
- Add a bookmark
https://github.com/node-red/node-red-web-nodes/tree/master/flickr
- Added a photo (filter by tag etc)
- Upload photo
Input events require https callback.
- Added a photo (filter by tag etc, photo OR video?)
- Like a photo
- A specific user has added a photo
API is currently read-only... no outputs possible
- ...
- Get file content
- Write to a file (replace/append)