Store adapter — LimeLight¶
The adapter
object contains properties for connecting to the LimeLight API.
Parent object: a store with property "platform" : "limelight"
Required properties¶
The following adapter
properties are required for LimeLight stores.
password
¶
Property | password |
---|---|
Name | LimeLight API Password |
Data type | string |
Required? | Yes |
url
¶
Property | url |
---|---|
Name | LimeLight Admin URL |
Data type | string |
Required? | Yes |
username
¶
Property | username |
---|---|
Name | LimeLight API Username |
Data type | string |
Required? | Yes |
Optional properties¶
The following adapter
properties are optional for LimeLight stores.
campaign_ids
¶
Property | campaign_ids |
---|---|
Name | Campaigns To Import |
Description | Only orders for the specified Campaigns will be imported |
Data type | array of strings |
Example | [ "abc123", "bcd234" ] |
Example¶
Example: create a new LimeLight store
curl -X POST \
-H "Authorization: Bearer $JWT_TOKEN" \
-H "Content-Type: application/json" \
https://api.getdropstream.com/stores \
-d @- <<EOF
{ "customer_id": "3775",
"name": "Your LimeLight Store",
"platform": "limelight",
"adapter": {
"url": "https://www.example.com",
"username": "abc123",
"password": "abc123",
"campaign_ids": [ "abc123", "bcd234" ]
}
}
EOF
For details about this request type, see: Create a new store.