List strings

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/strings

Language

Credentials

Secret key

Instance keyRemember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Query

languagebranding

cURL request

curl --request GET \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings';
const options = {method: 'GET', headers: {Authorization: 'Basic <base64 of SECRET_KEY:>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings"

headers = {"Authorization": "Basic <base64 of SECRET_KEY:>"}

response = requests.get(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings', [
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/strings"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://app.shuttleglobal.com/c/api/strings';
const options = {method: 'GET', headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/strings', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/strings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/strings"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

All strings for the language

{
  "strings": [
    {
      "id": "web.payment_form.card_number",
      "text": "رقم البطاقة",
      "branding": "brd_123",
      "language": "ar",
      "overriding": "Card Number"
    },
    {
      "id": "web.payment_processing.error",
      "text": "There was a problem processing the payment.",
      "branding": "brd_123",
      "language": "ar"
    }
  ]
}

GET

/strings

Returns every string that can be changed, with the wording that currently applies for the language requested.

Strings that have not been translated into the language return the wording they inherit, so listing a language you have not used yet returns the full set ready to translate. A string that has its own wording in this language carries overriding, the wording it would otherwise inherit.

This list does not take criteria, order or expand, and is not paginated: it always returns the complete set.

Authorizations

basicAuth
bearerAuth

Parameters

Query Parameters

language

string

default "default"

e.g. "ar"

Lowercase two-letter ISO 639-1 language code (e.g. ar), or default for the base wording. Defaults to default.

branding

string

Enterprise field, for accounts with more than one branding. Leave out to use your own branding.

Responses

200

All strings for the language

application/json

object

strings

Array<object>

A customer-facing string and the wording that applies for one language

object

string

String id, <set>.<key>

text

string

The wording that currently applies

language

string

Language the wording applies to

branding

string

Enterprise field. The branding the wording applies to

overriding

string

Present only when the string has its own wording for this language. Holds the wording it would otherwise inherit, which is what it goes back to if reset

Example

{
  "strings": [
    {
      "id": "web.payment_form.card_number",
      "text": "رقم البطاقة",
      "branding": "brd_123",
      "language": "ar",
      "overriding": "Card Number"
    },
    {
      "id": "web.payment_processing.error",
      "text": "There was a problem processing the payment.",
      "branding": "brd_123",
      "language": "ar"
    }
  ]
}

401

Authentication required

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

Was this page helpful?