Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

Create a new link for the client client  {instance_id}.

URI Parameters

...

Requests

Body
application/json

...

Get Token

Get the token to connect with the user service.

Code Block
titleExample application/json
collapsetrue
{
  "activation_date": null,
  "created_on": "2017-08-08T15:27:43",
  "deactivation_date": null,
  "enabled": true,
  "extra": {
    "user": "-"
  },
  "keywords": [
      "raffle"
  ],
  "lang": "en",
  "match_all": false,
  "title": "Raffle",
  "type": "DIRECT",
  "url": "https://empathybroker.com/raffle",
  "weight": 0
}

...

languagebash
titleUser Service Token
curl --request POST \
  --url https://api.empathybroker.com/user/v1/user/login \
  --header 'Content-Type: application/json' \
  --data '{
	"user": "",
	"password": ""
}'

Direct Link

Code Block
titleExample application/json
collapsetrue
{
  "activation_date": null,
  "deactivationcreated_dateon": null,   "enabled": true"2017-08-08T15:27:43",
  "extradeactivation_date": {null,
    "userenabled": "-"
  }true,
  "keywords": [
      "raffle"
  ],
  "lang": "en",
  "match_all": false,
  "title": "Raffle",
  "image_url": "unnamed.png",
  "type": "BANNERDIRECT",
  "url": "https://empathybroker.com/raffle",
  "weight": 0
}

...

Banner Link

Code Block
titleExample application/json
collapsetrue
{
  "activation_date": null,
  "deactivation_date": null,
  "enabled": true,
  "extra": {
 
  "user": "-"
  },
  "keywords": [
      "raffle"
  ],
  "lang": "en",
  "match_all": false,
  "title": "Raffle",
  "image_url": "unnamed.png",
  "type": "PROMOTEDBANNER",
  "url": "https://empathybroker.com/raffle",
  "weight": 0
}


image_url in BABBER and PROMOTED links

To add the url image it is necessary to add an image through the following information Empathy Play Api - Post image.


See Empathy Play API - Models for details. All non-optional fields must be included in the request.

...

401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
  "message": "Unauthorized",
  "status": "error"
}

...