/sharing/broadcast

The broadcast call shares activity information directly with a provider. The information provided in the parameters is passed along to a provider to publish on their network.

The broadcast call shares with one provider at a time, determined by the identifier or device_token that you use.

Note. Not all providers support all sharing parameters. To see which providers support what features, refer to the Sharing Support by Provider page.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it.

For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

Base URL

The base URL for this endpoint is your application domain followed by /api/v2; for example:

https://educationcenter.rpxnow.com/api/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

Example Request

The response includes a "share" element which returns fields that were actually passed to the provider. If the provider does not support a parameter, it will not be included in the result. For example, if the customer passed in a parameter for "media" but the provider does not accept that parameter, it will be missing from the "share" response.


curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234\
    --data-urlencode identifier=0987098709870987 \
    --data-urlencode message='Testing one two three'\
    --data-urlencode title='My title'\
    --data-urlencode url=http://test.com \
    --data-urlencode image=http://www.janrain.com/sites.default/themes/janrain/logo.png \
    --data-urlencode actionLink='{"name": "Example", "link": "http://www.example.com"}'\
    https://janrain-docs.rpxnow.com/api/v2/sharing/broadcast
                

Example Response


{
  "provider": "facebook",
  "mode": "broadcast",
  "success": true,
  "results": [
    {
      "success": true,
      "recipientId": "me",
      "shareResultUrl": "http://wwww.facebook.com/100002302927767/posts/939384179481671",
      "share": {
        "message": "Hey come look at this amazing thing!",
        "title": "Share this!",
        "url": "http://rpx.me/QlU9l",
        "description": "Fractal image.",
        "image": "http://www.coolmath.com/fractals/images/fractal11.gif",
        "media": "",
        "actionName": "",
        "objectName": "",
        "objectId": ""
      },
      "messageId": "100002302927767_939384179481671"
    }
  ]
}
                

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Query Parameters

Parameter Type Required Description
actionLink string Link that appears beneath user-generated message and content fields. In the case of Facebook, this link appears next to the Like and Comment links.
 
apiKey string Yes Social Login API key. This key can be found on the Janrain Dashboard.
 
description string Description of the shared content. The description appears in the preview of the shared object and explains what is being shared.
 
device_token string Identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
 
identifier string Identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
 
image string Image associated with the content being shared.
 
media string Flash or video object associated with the content being shared.
 
message string Message associated with the activity being shared.
 
objectID string Facebook-only. Use this parameter to share to a Facebook fan page instead of the User's wall. The value is the Object ID assigned to the fan page. See the Facebook developer documentation for more information on the Object ID.
 
shortenUrl string When false, disables the Janrain URL shortening service. When true, activates URL shortening.
 
source string URL of the site sharing the activity.
 
title string Title given to the shared content.
 
url string URL of the content being shared.