Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to include Single-User Auth Info #59

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README to include Single-User Auth Info #59

wants to merge 2 commits into from

Conversation

alkrauss48
Copy link

I just upgraded to the V3 API (very nice job), but I was a little confused on authenticating. I only ever needed to authenticate as a single user, and thus didn't need to go through the hassle of building multi-user authentication. This information wasn't in this repo, so I had to go digging and found out about single-user auth on the Vimeo documentation on the API site.

I feel like this is probably a common enough occurance to warrant placing it in the readme. I retrieved all text from the Vimeo API site.

I just upgraded to the V3 API (very nice job), but I was a little confused on authenticating. I only ever needed to authenticate as a single user, and thus didn't need to go through the hassle of building multi-user authentication. This information wasn't in this repo, so I had to go digging and found out about single-user auth on the Vimeo documentation on the API site.

I feel like this is probably a common enough occurance to warrant placing it in the readme. I retrieved all text from the Vimeo API site.
@@ -87,6 +87,18 @@ $lib->setToken($token->access_token)
### Authenticated


#### Single User Applications

If you only ever plan on interacting with a single user account feel free to hard code your access tokens into your app. This token should follow the spec described under authenticated requests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets drop the second sentence, and just keep it as...

If you only ever plan on interacting with a single user account, feel free to hard code (or preferably configure) your access tokens into your app.


```php
$lib->setToken($access_token);
```
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Dashron this look good - or do you want the code example gone too?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely keep the example. This looks good.

Just fill out our CLA (keeps the code licensing clear): developer.vimeo.com/cla and I'll merge this in.

@r-a-y
Copy link

r-a-y commented Dec 22, 2015

+1!

@pungp0
Copy link

pungp0 commented Mar 2, 2018

Yes

@CLAassistant
Copy link

CLAassistant commented Nov 22, 2019

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@campbellmarc campbellmarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants