Updated Web Nodes outline (markdown)

hbeeken 2014-09-30 06:46:57 -07:00
parent 25854b6326
commit 781c0013f3
1 changed files with 112 additions and 104 deletions

@ -1,105 +1,113 @@
This is a list of web APIs we want to start creating nodes for. 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. 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. 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.
--- ---
#### FourSquare #### FourSquare
##### Issues ##### Issues
* Input events require https callback. * 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. * 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.
##### Inputs ##### Inputs
* New checkin for the authenticated user * New checkin for the authenticated user
* New checkin for another user * New checkin for another user
* New checkin from authenticated user's friends * New checkin from authenticated user's friends
Could consider adding additional filter options - tag, category, geographic region... Notes:
##### Query * 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...
##### Outputs
* Create a checkin event ##### Query
* 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'
#### Dropbox Notes:
* Always return the most recent check-in since the node was initialized.
##### Inputs
* New file in a watched folder ##### Outputs
* Create a checkin event
##### Query
* Get file contents ---
##### Outputs #### Dropbox
* Write to a file (replace/append)
##### Inputs
--- * New file in a watched folder
#### Facebook ##### Query
* Get file contents
##### Inputs
* _Need to review API to see what events we can monitor_ ##### Outputs
* Write to a file (replace/append)
##### Query
* ... lots ... ---
##### Outputs #### Facebook
* Status update
* Link share ##### Inputs
* Upload photo to a specified album * _Need to review API to see what events we can monitor_
--- ##### Query
* ... lots ...
#### Delicious
##### Outputs
https://github.com/node-red/node-red-web-nodes/tree/master/delicious * Status update
* Link share
##### Inputs * Upload photo to a specified album
* ...
---
##### Outputs
* [x] Add a bookmark #### Delicious
--- https://github.com/node-red/node-red-web-nodes/tree/master/delicious
#### Flickr ##### Inputs
* ...
https://github.com/node-red/node-red-web-nodes/tree/master/flickr
##### Outputs
##### Inputs * [x] Add a bookmark
* Added a photo (filter by tag etc)
---
##### Outputs
* [x] Upload photo #### Flickr
--- https://github.com/node-red/node-red-web-nodes/tree/master/flickr
#### Instagram ##### Inputs
* Added a photo (filter by tag etc)
Input events require https callback.
##### Outputs
##### Inputs * [x] Upload photo
* Added a photo (filter by tag etc, photo OR video?)
* Like a photo ---
* A specific user has added a photo
#### Instagram
##### Outputs
API is currently read-only... no outputs possible Input events require https callback.
--- ##### Inputs
* Added a photo (filter by tag etc, photo OR video?)
#### Box * Like a photo
* A specific user has added a photo
##### Inputs
* ... ##### Outputs
API is currently read-only... no outputs possible
##### Query
* Get file content ---
##### Outputs #### Box
##### Inputs
* ...
##### Query
* Get file content
##### Outputs
* Write to a file (replace/append) * Write to a file (replace/append)