doc / api

Commit e8b18f5488697485e61938c931a1cf1b20239ef0

Authored by Esaú Freitas
1 parent c84ff736

ajustes

Inline Side-by-side
Showing 1 changed file with 14 additions and 12 deletions
Readme.md
  View file @e8b18f5
1 1 # Authenticate
2 2  
3   -```sh
4   -https://service2.funifier.com/2.0.0/authenticate?api_
5   -```
6   -
7 3 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.
  4 +
8 5 GET Method
9 6  
  7 +```sh
  8 +https://service2.funifier.com/2.0.0/authenticate
  9 +```
  10 +
10 11 **Parameters** .
11 12  
12   - - api_key : **String** - Required
13   - - app_secret : **String** - Optional
14   - - auth_mode : **String** - Required
15   - - app_secret : **String** - Optional
16   - - auth_mode : **String** - Required
17   - - password : **String** - Optional
18   - - expiration : **int**- Optional
19   - - callback : **String** Optional
  13 + - api_key: **String/Required** - Field that identify the key of gamification
  14 + - auth_mode: **String/Required** - Identify which method of authentication will use. The values can be [IMPLICIT,PASSWORD,CREDENTIAL,FACEBOOK]
  15 + - oauth_access_token: **String/Optional** - Use this field when the auth_mode is FACEBOOK. This value is the Facbook Token
  16 + - player: **String/Required** - Identify the Player of gamification
  17 + - app_secret: **String/Optional** - Token security, create this app_secret value in funfier studio on menu security
  18 + - password: **String/Optional** - Use this field when the auth_mode authentication is PASSWORD
  19 + - expiration: **int/Optional** - Used to define expirations time in seconds of sessions
  20 + - language: **int/Optional** - Set the default language in authentication
  21 + - callback: **String/Optional** - Use to callbacks in javascript
20 22  
21 23 ### Example Request
22 24 ```sh
... ...