GraphQL API

SignageLab poskytuje GraphQL API dostupné na adrese:

https://my.signagelab.com/api/graphql

Autentizace

Všechny požadavky na API vyžadují bearer token pro autentizaci.

Získání Bearer Tokenu

Přejděte do svého uživatelského profilu v CMS

Vytvořte nový API token

Nastavte dobu platnosti tokenu

Pojmenujte jej popisným názvem pro snadnou identifikaci

Zkopírujte vygenerovaný token

Token uchovávejte v bezpečí. V případě kompromitace ho můžete deaktivovat ve svém uživatelském profilu.

Dokumentace API

Kompletní schéma API a dostupné query/mutace můžete prozkoumat otevřením GraphQL endpointu v prohlížeči:

https://my.signagelab.com/api/graphql

GraphQL playground poskytuje:

Interaktivní dokumentaci všech dostupných operací
Autocomplete pro pole a argumenty
Introspekci schématu

Alternativně můžete použít introspekci schématu k vygenerování TypeScript typů do vašeho kódu, což umožní typově bezpečná volání API.

Volání API

Hlavičky

Všechny požadavky musí obsahovat hlavičku Authorization s vaším bearer tokenem:

Authorization: Bearer VÁŠ_TOKEN

Pro operace v rámci konkrétního účtu musíte také přidat hlavičku account:

account: ID_ÚČTU

Příklady

Obecné query (nevyžaduje scope na účet):

curl -X POST https://my.signagelab.com/api/graphql \
  -H "Authorization: Bearer VÁŠ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":"query { accounts { id name } }"}'

Query v rámci účtu:

curl -X POST https://my.signagelab.com/api/graphql \
  -H "Authorization: Bearer VÁŠ_TOKEN" \
  -H "account: ID_ÚČTU" \
  -H "Content-Type: application/json" \
  -d '{"query":"query { account(id: \"ID_账户\") { id name } }"}'

Zařízení

Kampaně

Nastavení & Integrace

Autentizace

Získání Bearer Tokenu

Dokumentace API

Volání API

Hlavičky

Příklady

​Autentizace

​Získání Bearer Tokenu

​Dokumentace API

​Volání API

​Hlavičky

​Příklady

Autentizace

Získání Bearer Tokenu

Dokumentace API

Volání API

Hlavičky

Příklady