diff --git a/README.md b/README.md index 67d6461..cf31d47 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,19 @@ An API exists on TwitchTokenGenerator allowing the creation of tokens and implem 1. Ping the create endpoint to get a link to give to user: - Create Endpoint: `https://twitchtokengenerator.com/api/create` - Required Rarameters: + -- base64 encoded application title + -- 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 + - Example status: `https://twitchtokengenerator.com/api/status/rtotgzqct6ro6nwlwr04` ### Credits - Xxplosions' twitchtv-oauth: [Xxplosions/twitchtv-oauth](https://github.com/Xxplosions/twitchtv-oauth)