~vesto/huginn_venmo_agent

cb47e66468232c2b77aac431841b2d2dea2cf236 — Steve Gattuso 3 years ago 16b1ea0
add instructions for venmo
1 files changed, 11 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +11 -0
@@ 17,6 17,8 @@ or, if you wish to stay on the bleeding edge:
ADDITIONAL_GEMS=huginn_sqlite3_agent(git:https://github.com/stevenleeg/huginn_venmo_agent.git)
```

## Usage
### Access Token
Each of the agents provided by this gem require a Venmo access token. This part is a bit tricky, but I've included a Rake task that should hopefully make the process easier. After installing the gem, run the following command in the directory Huginn is installed in:

```


@@ 26,3 28,12 @@ $ rake venmo:authenticate
You'll be prompted to enter your username, password and possibly a 2FA token in order to generate the access token that can be used with these agents. You'll likely want to store these in a credential that can be reused between multiple agents.

**NOTE:** Your Venmo access token is a very important credential that *must* be kept secret. If a malicious actor were to find this secret, they can do anything you can do with the actual Venmo app. *This includes sending money!* While there are some safeguards in place (ie daily transaction limits), you should be extra super duper careful to ensure this token does not get leaked out of your Huginn instance. I take no responsibility for any security issues that may arise from the usage of this Gem.

### Finding User IDs
In order to begin sending requests via the `CreateVenmoTransaction` agent, you'll need to find your friends' Venmo user IDs. I haven't yet found a way to do this outside of the API (if anyone knows please open an issue!), however this gem includes a rake task that should hopefully make the process easier. Run the following command in the directory Huginn is installed in:

```
$ rake venmo:search
```

You will be prompted to enter your Venmo auth token and for a Venmo username. The script will then ping the Venmo search API and return the results, within which you can find the user ID that can be used to make transactions.