Admin Guide

Synapse-Twitter Admin Guide

Configuration

Synapse-Twitter requires a Twitter API key (specifically the Bearer Token). For information on how to signup, please visit the Twitter API documentation.

Setting API key for global use

To set-up a global API key using a Bearer Token:

> twitter.setup.apikey myapikey
Setting Synapse-Twitter API key for all users.

Using per-user API keys

A user may set-up their own API key using their own Bearer Token:

> twitter.setup.apikey --self myapikey
Setting Synapse-Twitter API key for the current user.

Permissions

Package (synapse-twitter) defines the following permissions:
power-ups.twitter.user           : Controls user access to Synapse-Twitter. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.twitter.user
Added rule power-ups.twitter.user to user visi.

or:

> auth.role.addrule ninjas power-ups.twitter.user
Added rule power-ups.twitter.user to role ninjas.

Exported APIs

Synapse-Twitter does not currently export any APIs.

Node Actions

Synapse-Twitter provides the following node actions in Optic:

Name : twitter.feed.adduser
Desc : Add a web account to the accounts being monitored.
Forms: inet:web:acct

Name : twitter.feed.deluser
Desc : Remove an account from the accounts being monitored.
Forms: inet:web:acct

Name : twitter.user.profile
Desc : Enrich an account node of a twitter profile.
Forms: inet:web:acct

Name : twitter.user.following
Desc : Ingest the accounts that this account follows.
Forms: inet:web:acct

Name : twitter.user.followers
Desc : Get the followers of an account.
Forms: inet:web:acct

Name : twitter.user.tweets
Desc : Ingest the tweets of an account.
Forms: inet:web:acct

Onload Events

Synapse-Twitter does not use any onload events.