Goldilox API

• auth-controller
  • postGet device authentication JWT token.
• banner-rate-controller
  • getgetBannerRate
  • getgetBannerRate
• config-controller
  • getGet client specific device configuration.
• device-state-controller
  • getGets actions for client device.
• selector-controller
  • getGet content categories for the client.
  • postGet content for the client.

Documented w/Open API v3.0.2

Goldilox API (3.0)

Download OpenAPI specification:Download

Baby Bear: baby@thehouseinthewoods.com

Goldilox Server APIs

auth-controller

Operations to device authentication

Get device authentication JWT token.

path Parameters

apiVersion required	string apiVersion
partnerCode required	string partnerCode

header Parameters

Authorization

string JWToken

Request Body schema: application/json

tokenRequest

awsAccessKey	string
awsSecretKey	string
cognitoId	string
cognitoSessionToken	string
legacyDeviceAuthToken	string
legacyDeviceId	string
pinpointId	string

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post /api/{apiVersion}/{partnerCode}/device/auth

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/device/auth

Request samples

• Payload

application/json

Copy

Expand all Collapse all

{

• "awsAccessKey": "string",
• "awsSecretKey": "string",
• "cognitoId": "string",
• "cognitoSessionToken": "string",
• "legacyDeviceAuthToken": "string",
• "legacyDeviceId": "string",
• "pinpointId": "string"

}

banner-rate-controller

Banner Rate Controller

getBannerRate

path Parameters

apiVersion required	string API and operation version number.
partnerCode required	string Code used to identify which partner the operation applies to.

query Parameters

date	string <date> date
step	string step

header Parameters

Authorization

string JWToken

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/{apiVersion}/{partnerCode}/content/bannerrate

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/content/bannerrate

getBannerRate

path Parameters

apiVersion required	string API and operation version number.
partnerCode required	string Code used to identify which partner the operation applies to.
rulesetId required	string rulesetId

query Parameters

date	string <date> date
step	string step

header Parameters

Authorization

string JWToken

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/{apiVersion}/{partnerCode}/content/bannerrate/{rulesetId}

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/content/bannerrate/{rulesetId}

config-controller

Config Controller

Get client specific device configuration.

path Parameters

apiVersion required	string apiVersion
partnerCode required	string partnerCode

query Parameters

clientVersion required	string clientVersion
clientVersionCode	string Default: "0" clientVersionCode
platform required	string platform
platformVersion required	string platformVersion

header Parameters

Authorization

string JWToken

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/{apiVersion}/{partnerCode}/device/config

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/device/config

device-state-controller

Device State Controller

Gets actions for client device.

path Parameters

apiVersion required	string apiVersion
partnerCode required	string partnerCode
state required	string state

header Parameters

Authorization

string JWToken

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/{apiVersion}/{partnerCode}/device/status/{state}

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/device/status/{state}

selector-controller

Selector Controller

Get content categories for the client.

path Parameters

apiVersion required	string API and operation version number.
partnerCode required	string Code used to identify which partner the operation applies to.

header Parameters

Authorization

string JWToken

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/{apiVersion}/{partnerCode}/content/categories

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/content/categories

Response samples

• 200

application/json;charset=UTF-8

Copy

Expand all Collapse all

{

• "categories":

  [

  • {

    • "id": "string",
    • "name": "string"

    }

  ]

}

Get content for the client.

path Parameters

apiVersion required	string API and operation version number.
partnerCode required	string Code used to identify which partner the operation applies to.

header Parameters

Authorization

string JWToken

Request Body schema: application/json;charset=UTF-8

contentRequest

metrics	object
ruleset-id	Array of string

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post /api/{apiVersion}/{partnerCode}/content/selector

https://0.0.0.0:8080/api/api/{apiVersion}/{partnerCode}/content/selector

Request samples

• Payload

application/json;charset=UTF-8

Copy

Expand all Collapse all

{

• "metrics":

  {

  • "property1": "string",
  • "property2": "string"

  },
• "ruleset-id":

  [

  • "string"

  ]

}

Response samples

• 200

application/json;charset=UTF-8

Copy

Expand all Collapse all

{

• "displayType": "string",
• "displayView": "string",
• "layout":

  {

  • "height": "string",
  • "width": "string"

  },
• "notification":

  {

  • "text": "string",
  • "title": "string"

  },
• "url": "string"

}