/config/{appId}/flows/{flow}/locales/{locale}/strings

Returns information about all the strings defined for a locale. Strings represent the UI text used on web pages built using the JavaScript SDK or Hosted Login.

This endpoint supports the following methods:

• GET
• POST

GET

Description

Returns a list of strings defined in the flow.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:

https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

• us 
• eu 
• au 
• sa 
• cn
• sg

Sample Request (curl)

This command returns all the strings associated with the en-US version of the documentation flow.

curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings 

Responses

200 OK

Response Example (application/json)

[
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/emailAddressData",
    "name": "emailAddressData"
  },
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByJanrain",
    "name": "poweredByJanrain"
  }
]

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)

{
  "errors": "String not found."
}
                                                            

POST

Description

Adds a string to the flow.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:

https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

• us 
• eu 
• au 
• sa 
• cn
• sg

Request Example (application/json)

{
  "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByJanrain",
  "name": "poweredByJanrain",
  "value": "Powered by Janrain"
}

Sample Request (curl)

This command adds a new string to the en-US version of the documentation flow.

curl -X POST \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "educationCenter",
    "value": "The Akamai Education Center"
  }'

Responses

201 Created

Successfully created a new String.

Response Headers

Location string

The location of the newly-created String.

Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/strings/poweredByJanrain

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)

{
  "errors": "String not found."
}
                                                            

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

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