Back to top

Upfluence Authentification system

Scopes

Upfluence software is a set of multiple applications. Each of those applications use the same authentification system. In order to redeem a valid access_token to use a specfic application you should provide the correct scope.

The available scopes are:

Scope API documentation
facade_api http://docs.api.upfluence.co
publishr_api http://docs.publishr.upfluence.co
analytics_api http://docs.analytics.upfluence.co

OAuth endpoint

OAuth token exchange

Exchange credentials for token
POST/token

In order to access protected resources, you need to redeem a token from our authentification API

Exchange credentials for access_token.

Supported grant_type:

  • password

If you select this specific grant_type, you should provide some fields:

  • email: The email linked to your Upfluence account

  • password: The password linked to your Upfluence accoumt

  • scope: A correct scope related to the application you want to use, the list available scopes is defined here

  • refresh_token

If you select this specific grant_type, you should provide some fields:

  • refresh_token: A valid value of a refreshed token provided during a previous authentification with the grant_type: password

By default the access_token redeemed expires after 15 minutes. You can increase or decrease this expiration date, by providing an token_lifetime key/value in the payload. The value is an integer representing the number of seconds the token is valid. For security purposes the lifetime of an acces_token is limited to a month.

If the authentification credentials provided are correct a status code 200 will be returned along with an access token in the body.

If the field scope is either not valid or not available for your account the API will respond with a status code 400 and {"error": "invalid_grant"} body.

Example URI

POST https://identity.upfluence.co/token
Request  password
HideShow
Headers
Content-Type: application/json
Body
{
  "grant_type": "password",
  "token_lifetime": 3600,
  "username": "your@email.com",
  "password": "mypassword",
  "scope": "facade_api"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "eyJhbGciOiJIUzI1NiJ9.e30.XmNK3GpH3Ys_7wsYBfq4C3M6goz71I7dTgUkuIa5lyQ",
  "expires_in": 900,
  "token_type": "bearer",
  "refresh_token": "0zpKHOVn0pr5ejbTHS5q2Voko0QEwlSRJHnvfoBpp+8Z/90EySEH/BZ8Ui6/5JkB85aTGTn3XlQYZmeB0XJmFA=="
}
Request  refresh_token
HideShow
Headers
Content-Type: application/json
Body
{
  "grant_type": "refresh_token",
  "token_lifetime": 3600,
  "refresh_token": "Hello, world!"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "eyJhbGciOiJIUzI1NiJ9.e30.XmNK3GpH3Ys_7wsYBfq4C3M6goz71I7dTgUkuIa5lyQ",
  "expires_in": 900,
  "token_type": "bearer",
  "refresh_token": "0zpKHOVn0pr5ejbTHS5q2Voko0QEwlSRJHnvfoBpp+8Z/90EySEH/BZ8Ui6/5JkB85aTGTn3XlQYZmeB0XJmFA=="
}