Superaudio.com.br

Documentação App Superaudio Rádios

Em caso de erro, a maioria dos endpoints abaixo retorna um corpo no formato { "status": "error", "code": <HTTP status>, "message": "..." }, com o mesmo valor de code refletido no status HTTP da resposta. Os códigos mais comuns são: 400 (parâmetro inválido/erro genérico), 401 ou 403 (token ausente, inválido ou sem permissão, dependendo do endpoint), 404 (registro não encontrado), 503 (recurso desabilitado para a companhia) e 500 (erro interno não tratado).

Exceção: Enviar mensagem de contato retorna, em erro, { "type": "error", "message": "..." } (sem o campo code).

GET /controla/app-superaudio-radios/get-company/{:companyId}/{:token} Buscar dados da companhia

Retorna os dados da companhia identificada por companyId, validando o token gerado na aba App, incluindo a promoção em destaque (featured_promotion).

Parâmetros da URL

companyIdobrigatório	ID da companhia.
tokenobrigatório	Token da companhia gerado na aba App.

200Sucesso

{
    "status": "success",
    "code": 200,
    "company": { "...": "..." },
    "featured_promotion": { "...": "..." }
}

403Token inválido/ausente

{
    "status": "error",
    "code": 403,
    "message": "You are not allowed to access this location!"
}

404Companhia não encontrada

{
    "status": "error",
    "code": 404,
    "message": "Company not found"
}

503App desabilitado para a companhia

{
    "status": "error",
    "code": 503,
    "message": "Unavailable - App is not enabled"
}

GET /controla/app-superaudio-radios/get-radios/{:companyId}/{:token} Buscar rádios da companhia

Retorna a lista de rádios (branches) da companhia identificada por companyId.

Parâmetros da URL

companyIdobrigatório	ID da companhia.
tokenobrigatório	Token da companhia gerado na aba App.

Parâmetros GET (querystring, opcional)

segment_id

ID de um segmento.

GET /controla/app-superaudio-radios/get-branch-programs/{:branchId}/{:token} Buscar a programação de uma rádio

Retorna a programação da rádio identificada por branchId.

Parâmetros da URL

branchIdobrigatório	ID da Rádio.
tokenobrigatório	Token da companhia gerado na aba App.

GET /controla/app-superaudio-radios/get-podcasts/{:token} Buscar Podcasts da companhia

Retorna a lista de podcasts (tipos de mídia) da companhia associada ao token.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /controla/app-superaudio-radios/get-content-podcast/{:token}/{:podcastId}/{:page} Buscar conteúdos de um Podcast

Retorna os conteúdos de um podcast (tipo de mídia) da companhia. Possui redis de 30 minutos.

Parâmetros da URL

tokenobrigatório	Token da companhia gerado na aba App.
podcastIdobrigatório	ID do podcast (tipo de mídia).
page	Página da listagem de conteúdos. Não obrigatório, valor padrão: 1.

GET /api/app/podcasts/latest-versions/{:token} Buscar últimos conteúdos dos podcasts da companhia

Busca as últimas versões em ordem decrescente dos podcasts importados pela companhia. Possui redis de 30 minutos.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Parâmetros GET (querystring, todos opcionais)

page	Página da listagem. Default: 1.
limit	Limite de itens por página. Default: 15.

GET /api/app/banners/:token Buscar banners da companhia

Retorna a lista de banners da companhia associada ao token.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /api/app/live-videos/{:token} Buscar Vídeos ao Vivo

Retorna a lista de vídeos ao vivo da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Parâmetros GET (querystring, opcional)

title Título do vídeo ao vivo. Ex: /api/app/live-videos/913330AC3ED50DAD2F8A3C8796771CED36743E0F?title=SBGR

GET /api/app/categories-tags/{:token} Buscar Categorias e Tags

Retorna as categorias e tags multimídia da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /api/app/news/{:token} Buscar lista de notícias da companhia

Retorna a lista de notícias da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Parâmetros GET (querystring, todos opcionais)

headline	Manchete.
categoryId	ID de uma categoria multimídia.
tags	Lista de IDs separados por `\|`, ex: `25\|26\|27\|28`.

GET /api/app/news/{:newsId}/{:token} Buscar uma notícia específica da companhia

Retorna uma notícia específica da companhia.

Parâmetros da URL

newsIdobrigatório	ID da notícia.
tokenobrigatório	Token da companhia gerado na aba App.

GET /api/app/gallery/videos/{:token} Buscar lista de Vídeos da Galeria

Retorna a lista de vídeos da galeria da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Parâmetros GET (querystring, todos opcionais)

title	Título do vídeo.
categoryId	ID de uma categoria multimídia.
tags	Lista de IDs separados por `\|`, ex: `25\|26\|27\|28`.

GET /api/app/gallery/videos/{:videoId}/{:token} Buscar um vídeo da galeria

Retorna um vídeo específico da galeria.

Parâmetros da URL

videoIdobrigatório	ID do vídeo da galeria.
tokenobrigatório	Token da companhia gerado na aba App.

GET /api/app/highlight/{:token} Buscar notícias em destaque da companhia

Retorna as notícias em destaque da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Parâmetros GET (querystring, todos opcionais)

headline	Manchete.
categoryId	ID de uma categoria multimídia.
tags	Lista de IDs separados por `\|`, ex: `25\|26\|27\|28`.

GET /api/app/share-config/{:token} Buscar configurações de compartilhamento do app

Retorna os links de download nas lojas (iOS/Android) e a descrição usada ao compartilhar o app.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

POST /api/app/banners/impression/{:token} Registrar impressão de banner

Registra uma impressão de banner enviada pelo player.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Body (JSON)

banner_idobrigatório	int.
client_id	int, opcional.
impression_date	string ISO 8601, opcional; padrão: agora.

GET /api/app/colors/{:token} Buscar cores do app da companhia

Retorna as cores configuradas do app da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /api/app/want-adds/list-want-adds/{:token} Buscar lista de pedidos musicais (Quero Ouvir)

Retorna a lista de pedidos musicais (Quero Ouvir) da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /api/app/want-adds/get-want-add/{:token}/{:id} Buscar um pedido musical específico

Retorna um pedido musical específico (Quero Ouvir).

Parâmetros da URL

tokenobrigatório	Token da companhia gerado na aba App.
idobrigatório	ID do pedido musical.

GET /api/app/picture-albums/list-picture-albums/{:token} Buscar lista de álbuns de fotos

Retorna a lista de álbuns de fotos da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /api/app/picture-albums/get-picture-album/{:token}/{:id} Buscar um álbum de fotos específico

Retorna um álbum de fotos específico.

Parâmetros da URL

tokenobrigatório	Token da companhia gerado na aba App.
idobrigatório	ID do álbum de fotos.

POST /api/listener-messages/save-contact/{:token} Enviar mensagem de contato

Envia uma mensagem do ouvinte para a companhia (formulário de contato).

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

Body (JSON)

subjectobrigatório
nameobrigatório
messageobrigatório
phone	Opcional.
email	Opcional.

ERROCorpo inválido

{
    "type": "error",
    "message": "Informções incorretas."
}

GET /api/list-most-requested/{:token} Buscar lista das músicas mais pedidas

Retorna a lista das músicas mais pedidas da companhia.

Parâmetros da URL

tokenobrigatório

Token da companhia gerado na aba App.

GET /controla/app-superaudio-radios/view/{:token}/{:key}/{:filename}/{:aliasTable} Executar/Baixar Arquivo

Executa ou realiza o download de um arquivo através de sua key/filename.

Parâmetros da URL

tokenobrigatório	Token da companhia gerado na aba App.
keyobrigatório	Key do arquivo.
filenameobrigatório	Nome do arquivo.
aliasTable	Alias para uma tabela de upload específica. Não obrigatório, valor padrão: `uploads`. Options: `uploads`, `versions`, `api`.

GET /app/nowplaying/{:ID_RDS_RÁDIO} Buscar música tocando na rádio

Retorna a música tocando atualmente na rádio identificada pelo ID RDS.

Parâmetros da URL

ID_RDS_RÁDIOobrigatório ID definido no edit da rádio de companhia. Ex: /app/nowplaying/literadio

POST /api/radio-play/player/set-played Salvar música tocando na rádio (SyncPlay)

Salva a música/mídia que está tocando na rádio (SyncPlay).

Headers

authcodeobrigatório

AuthCode Station.

Body (JSON)

foreign_key	ID da música/mídia.
Model	Geralmente utilizado para diferenciar a tabela associada da chave estrangeira (foreign_key). Atualmente, é preenchido quando o type é media, music ou command. Se o type for command, será utilizada a model enviada na requisição; caso contrário, será definida como Musics ou Medias.
Type	Associação do tipo de mídia.
audio	Geralmente preenchido quando um arquivo é arrastado manualmente para a playlist, sem referência associada a um model e foreign_key no controle.
program_id	ID do programa ao qual o arquivo em reprodução pertence. Se informado, será validado se o programa existe na companhia da rádio associada ao authcode fornecido. Caso o programa não seja encontrado, o registro ainda será salvo, mas o valor será definido como null.
played_date	Data e o horário que tocou. Ex: Medias, Musics, StreamingIn.
block_date	(Y-m-d H:i:s) Ex: `2022-05-30 16:50:08`. Data do bloco comercial (Midia+).
file_path	Caminho do arquivo (Midia+).
file_time	(segundos) Tempo do arquivo (Midia+).
file_execution_time	(segundos) Horário que o arquivo foi executado (Midia+).
nro_int	ID do arquivo/Reconciliation number band (Gerado automaticamente pelo Midia+ e vem no arquivo dos blocos).