Skip to content

Commit

Permalink
Adds refresh API endpoint.
Browse files Browse the repository at this point in the history
  • Loading branch information
swiftyspiffy authored Oct 7, 2017
1 parent 7c4456f commit 51738e6
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,25 @@ An API exists on TwitchTokenGenerator allowing the creation of tokens and implem
- Create Endpoint: `https://twitchtokengenerator.com/api/create`
- Required Rarameters:

-- base64 encoded application title
- - base64 encoded application title

-- scope list with + delimiter
- - scope list with + delimiter

- Example create: `https://twitchtokengenerator.com/api/create/QXV0aEZsb3dFeGFtcGxlIFRlc3QgQXBwbGljYXRpb24=/chat_login+user_read`
2. Response will be a json object including success bool, an id, and a message string containing the auth url. Present the URL to the program user.
3. Your application should ping the status endpoint for updates on authorization. The status will return error 3 "Not authorized yet" until the user authorizes their account. After authorization, the status endpoint will return their credentials on the first ping post-authorization. Additional pings will return error 4 "API instance has already expired". This is to protect the user.
- Status endpoint: `https://twitchtokengenerator.com/api/status`
- Required Parameters:

-- Id of auth flow
- - Id of auth flow

- Example status: `https://twitchtokengenerator.com/api/status/rtotgzqct6ro6nwlwr04`
- Please record your access token as well as the refresh token for usage.
4. Occasionally you will find that your Twitch access token has expired. This is new as of Twitch's oAuth2 implementation. To refresh, use the "refresh" token that you received in step 3 and hit the /api/refresh/ endpoint to get a new token.
- Example refresh: `https://twitchtokengenerator.com/api/refresh/{refresh_token}`
### Credits
- Xxplosions' twitchtv-oauth: [Xxplosions/twitchtv-oauth](https://github.com/Xxplosions/twitchtv-oauth)
- MobileDetect: [http://mobiledetect.net/](http://mobiledetect.net/)

### License
MIT License. © 2017 Cole
MIT License. © 2017 Cole

0 comments on commit 51738e6

Please sign in to comment.