diff --git a/Readme.md b/Readme.md index 56f99a4..fe6381b 100644 --- a/Readme.md +++ b/Readme.md @@ -1,22 +1,24 @@ # Authenticate -```sh -https://service2.funifier.com/2.0.0/authenticate?api_ -``` - This method authenticate a player to your gamification and opens a session for the authenticated player on success. Authentication against the Funifier API is done with your gamification's API key, Authentication Mode and some combinations of credentials. + GET Method +```sh +https://service2.funifier.com/2.0.0/authenticate +``` + **Parameters** . - - api_key : **String** - Required - - app_secret : **String** - Optional - - auth_mode : **String** - Required - - app_secret : **String** - Optional - - auth_mode : **String** - Required - - password : **String** - Optional - - expiration : **int**- Optional - - callback : **String** Optional + - api_key: **String/Required** - Field that identify the key of gamification + - auth_mode: **String/Required** - Identify which method of authentication will use. The values can be [IMPLICIT,PASSWORD,CREDENTIAL,FACEBOOK] + - oauth_access_token: **String/Optional** - Use this field when the auth_mode is FACEBOOK. This value is the Facbook Token + - player: **String/Required** - Identify the Player of gamification + - app_secret: **String/Optional** - Token security, create this app_secret value in funfier studio on menu security + - password: **String/Optional** - Use this field when the auth_mode authentication is PASSWORD + - expiration: **int/Optional** - Used to define expirations time in seconds of sessions + - language: **int/Optional** - Set the default language in authentication + - callback: **String/Optional** - Use to callbacks in javascript ### Example Request ```sh