Referência · Conta

Empresas

Lista as empresas a que o usuário tem acesso e, em cada uma, o que ele pode consultar pela API. Esta resposta não é paginada.

Parâmetros

Este endpoint não recebe parâmetros.

Campos de cada item

uid string

Identificador da empresa. Use no parâmetro organization das listagens.

name string

Nome da empresa.

neutral_zone boolean

true se for uma empresa neutra, cujos arquivos e listas de reprodução podem ser usados por todas as outras empresas.

admin boolean

true se o usuário é administrador da empresa ou da empresa principal. Nesse caso, ele vê tudo da empresa.

permissions object

O que o usuário pode consultar nessa empresa.

permissions.tvs boolean

true se pode ver as TVs.

permissions.files boolean

true se pode ver os arquivos.

permissions.playlists boolean

true se pode ver as listas de reprodução.

Erros possíveis

• Os erros de chave e de limite valem para todos os endpoints. Ver todos os erros

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/organizations');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/organizations', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}