{
"embed_key": {
"embed_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"owner_kind": "partner",
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manufacturer_slug": "<string>",
"allowed_origins": [
"<string>"
],
"config": {},
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"manufacturer_context": {
"manufacturer_slug": "<string>"
},
"exclusions": {
"excluded_manufacturers": [
"<string>"
],
"excluded_device_types": [
"<string>"
],
"unsupported_providers": [
"<string>"
],
"capability": "<string>",
"capability_exclusions": [
{
"device_category": "<string>",
"manufacturer_slug": "<string>",
"provider_slug": "<string>"
}
]
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}Resolve an Embed Key
Validates an embed key against the request’s Origin and returns the key’s public record and the manufacturer a manufacturer key scopes widgets to (manufacturer_context, null for other keys). For a partner key, it also returns what the partner’s widgets must not show: the manufacturers, device types and providers the partner declared disabled or not supported through Seam and, given capability, the manufacturer and provider combinations excluded for that capability. Seam’s device database widgets call this endpoint.
{
"embed_key": {
"embed_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"owner_kind": "partner",
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manufacturer_slug": "<string>",
"allowed_origins": [
"<string>"
],
"config": {},
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"manufacturer_context": {
"manufacturer_slug": "<string>"
},
"exclusions": {
"excluded_manufacturers": [
"<string>"
],
"excluded_device_types": [
"<string>"
],
"unsupported_providers": [
"<string>"
],
"capability": "<string>",
"capability_exclusions": [
{
"device_category": "<string>",
"manufacturer_slug": "<string>",
"provider_slug": "<string>"
}
]
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}Authorizations
An embed key (eco_live_…) for browser requests; the request's Origin must match one of the key's allowed origins. Optional on most endpoints, but embed/resolve always needs one, and so does compatibility from a browser on a site other than seam.co. A manufacturer embed key implies its manufacturer.
Query Parameters
DeviceDB capability the widget is rendering (capability_name); adds capability_exclusions.
^[a-z0-9_]*$Response
OK
The key's public record, without the key value.
Show child attributes
Show child attributes
Set for manufacturer-owned keys; null for partner and Seam keys.
Show child attributes
Show child attributes
What a partner key's widgets must not show; empty for other keys.
Show child attributes
Show child attributes
Always true on success.
Was this page helpful?