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