BRCASTDOCS

  • Visando aprimorar a experiência do cliente BRLOGIC com seus serviços, disponiblizamos a API de desenvolvimento para o painel BRCAST, que tem como principal objetivo facilitar a criação de aplicativos integrados com o painel.

    Através da API, será possível criar aplicações que realizam tarefas como parar autodj, chutar a transmissão atual e também atualizar o nome da última música em execução, além de consultas como lista de ouvintes, número de ouvintes em determina hora, dia e semana, informações de música atual e próxima música, etc.

    O recurso pode ser facilmente utilizado, desde que liberado o acesso no painel para a aplicação que será desenvolvida por motivos de segurança.

  • Toda aplicação deverá ter um IP fixo para que possa ser autorizado o acesso da mesma aos dados do servidor, existem dois tipos de permissão:

    • Leitura : a aplicação poderá realizar operações apenas de leitura de informações;
    • Leitura e escrita : a aplicação terá acesso a todos os recursos da API.

    Observação: para que a aplicação tenha acesso aos recursos da API, não basta apenas o cadastro do IP com a permissão, será necessário que a mesma tenha as chaves públicas e privadas que estão disponíveis no link ?API de Desenvolvimento? dentro do painel BRCAST.

  • Leitura: get

    Segue abaixo a lista de operações de leitura:

    • status : retorna se a rádio e o autodj estão ligados;
    • all_status : retorna todas as informações disponíveis da rádio;
    • currenttrack: retorna a música atual, se disponível;
    • nexttrack: retorna a próxima música a ser executada pelo autodj, se disponível;
    • graph-listeners-weekday: retorna a média de ouvintes por dia da semana;
    • graph-listeners-day: retorna a média de ouvintes por hora do dia atual;
    • graph-listeners-hour: retora o número de ouvintes a cada 5 minutos.

    Escrita: set

    Segue abaixo a lista de operações de escrita:

    • updateinfo: atualiza o parâmetro de música atual;
    • kicksource: chuta a transmissão atual, podendo voltar dentro de instantes;
    • killautodj: para o serviço do autodj.

  • Atualmente a API de desenvolvimento do BRCAST tem duas opções de retorno, json e xml.

    Exemplo dos dois tipos de retornos:

    JSON:

    {"servidor":"on","autodj":"on","nexttrack":"04 - Strange Kind Of Woman.mp3"}

    XML:

    <?xml version="1.0" encoding="UTF-8"?>
<nexttrack>
<servidor>on</servidor>
<autodj>on</autodj>
<nexttrack>04 - Strange Kind Of Woman.mp3</nexttrack>
</nexttrack>

  • A BRLOGIC está trabalhando para construir exemplos de aplicações para as linguagens mais utilizadas:

    PHP

    <?php
require 'BRCAST.class.php';

//Instanciando objeto
$brcast = new BRCAST();
//Informando o IP de streaming
$brcast->ip = 'streaming02.brlogic.com';
//Coloque as chaves fornecidas pelo painel BRCAST
$brcast->public_code = 'P1-AAAAAA';
//Coloque as chaves fornecidas pelo painel BRCAST
$brcast->private_code = 'P2-AAAAAAA';

//Exemplo para pegar status do servidor
$status = $brcast->get('status', 'json');
//Imprimindo na tela o resultado
echo '<pre>';
print_r($status);
echo '</pre>';
?>

    Para fazer download da classe de API e do exemplo, clique aqui.

    (dot).NET

    Em breve.

    Java

    Em breve.