add Oauth documentation

botisimo · Apr 20, 2022 · 1cd5299 · 1cd5299
1 parent c80d770
commit 1cd5299
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/loyalty/documentation/authentication.rst b/docs/loyalty/documentation/authentication.rst
@@ -3,6 +3,7 @@ Authentication API
 
 - `Sign Up`_
 - `Log In`_
+- `Initiate OAuth Flow`_
 - `Get User`_
 
 Sign Up
@@ -124,6 +125,24 @@ user.tags.id                number   The ID of the tag
 user.tags.name              string   The name of the tag
 =========================== ======== ==========================================================================
 
+Initiate OAuth Flow
+-------------------
+
+To initiate an OAuth request, you should redirect the user to this URL. You should replace ``:team`` with your team's name in your Botisimo account. You should replace ``:platform`` with the platform you want to use.
+
+Platform can be: ``twitch``, ``youtube``, ``facebook``, ``instagram``, ``discord``, ``twitter``, ``spotify``, ``steam``, ``battlenet``, ``chess``, ``tiktok``
+
+- **GET** https://botisimo.com/api/v1/auth/:platform/user/loyalty/:team
+- **GET** https://botisimo.com/api/v1/auth/:platform/user/loyalty/:team?user_auth_token=xxxxxx
+
+Request
+
+=============== ======== ============================================================================================
+Field           Type     Description
+=============== ======== ============================================================================================
+user_auth_token [string] If the user is already logged in, you should include the authentication ``token`` in the URL
+=============== ======== ============================================================================================
+
 Get User
 --------