Retrieve Configuration

GET/v1/keys/{key}/configs/{config}

Returns a configuration by name. This request needs no user_token, so a browser integration can read its own configuration at runtime.

Path parameters

key string

API Key

The API Key to retrieve. Begins ak_.

Example ak_test

config string

Configuration Name

User-provided configuration object name.

Example checkout-form

Response

Returns the configuration object with its name, payload, and timestamps.

• result Config

  • updatedAt string

    Timestamp for when the config was created

    Example

    2016-01-21T17:14:49.971Z

  • createdAt string

    Timestamp for when the config was updated

    Example

    2016-01-21T17:14:49.971Z

  • name string

    A unique name to identify the configuration payload

    Example

    woocommerce

  • payload string

    A serialised payload of up to 65536 characters

    Example

    { "removeOrganisation": false }

The result sits inside the standard { result, code, message } envelope — see the API reference for the wrapper format.

Request

URL

https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret

curl

curl -G 'https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce' \
  -d 'user_token=uk_secret'

JavaScript

const response = await fetch(
  'https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce?' +
  new URLSearchParams({
    user_token: 'uk_secret',
  })
);

const { result } = await response.json();

Python

import requests

response = requests.get(
    "https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce",
    params={
        "user_token": "uk_secret",
    },
)
result = response.json()["result"]

Ruby

require "net/http"
require "json"

uri = URI("https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce")
uri.query = URI.encode_www_form(user_token: "uk_secret")
result = JSON.parse(Net::HTTP.get(uri))["result"]

PHP

<?php
$response = file_get_contents(
  "https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce?" .
  http_build_query([
    "user_token" => "uk_secret",
  ])
);
$result = json_decode($response, true)["result"];

Response

200 OK

{
  "result": {
    "updatedAt": "2016-01-21T17:14:49.971Z",
    "createdAt": "2016-01-21T17:14:49.971Z",
    "name": "woocommerce",
    "payload": "{\n  \"removeOrganisation\": false\n}\n"
  },
  "code": 2000,
  "message": "Success"
}