API de Playlists da KXMIDIA

Bem-vindo à documentação da API de Playlists da KXMIDIA. Esta API permite que sistemas externos consultem o conteúdo de playlists específicas, obtendo os URLs públicos de seus arquivos e suas respectivas categorias.

Endpoint

URL Base: https://tv.midiaindoor.app/painel/api

Método HTTP: GET

Parâmetros da Requisição

A requisição deve incluir o seguinte parâmetro na URL:

Parâmetro	Tipo	Obrigatório	Descrição
`code`	string	Sim	O código de acesso alfanumérico de 6 dígitos da playlist. Ex: `a3b4c5`.

Estrutura da Resposta

Todas as respostas da API são fornecidas no formato JSON.

1. Resposta de Sucesso (Status HTTP 200 OK)

Quando o code fornecido é válido e a playlist é encontrada, a API retornará um JSON com a lista de arquivos e seus tipos.

{
  "success": true,
  "files": [
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/usuario-x/arquivos/nome-da-playlist/video-institucional.mp4",
      "type": "video"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/usuario-x/arquivos/nome-da-playlist/banner-promocional.jpg",
      "type": "image"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/usuario-x/arquivos/nome-da-playlist/musica-ambiente.mp3",
      "type": "radio"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/usuario-x/arquivos/nome-da-playlist/info.txt",
      "type": "page"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/usuario-x/arquivos/nome-da-playlist/documento.pdf",
      "type": "other"
    }
  ]
}

success (booleano): Indica se a requisição foi bem-sucedida (true).
files (array de objetos): Contém uma lista de arquivos na playlist. Este array estará vazio se a playlist não tiver arquivos.
- url (string): A URL pública e completa do arquivo.
- type (string): A categoria do arquivo. As categorias possíveis incluem:
  - image: Para extensões como .jpg, .jpeg, .jpe, .png, .webp, .bmp.
  - video: Para extensões como .mp4, .webm, .avi, .mkv.
  - page: Para extensões como .txt.
  - radio: Para extensões como .mp3, .ogg.
  - other: Para qualquer outra extensão não listada acima.

2. Respostas de Erro

Em caso de erro, a API retornará um JSON com a seguinte estrutura:

{
  "success": false,
  "message": "Descrição do erro."
}

As possíveis situações de erro são:

Status HTTP	Mensagem de Erro	Motivo
400 Bad Request	`Código de acesso não fornecido.`	Ocorre quando o parâmetro `code` não é incluído na URL da requisição.
404 Not Found	`Playlist não encontrada.`	Acontece se o `code` enviado não corresponder a nenhuma playlist existente no sistema.
404 Not Found	`Diretório da playlist não encontrado no servidor.`	Indica que a playlist foi encontrada no banco de dados, mas o diretório físico dos arquivos não existe no servidor.
500 Internal Server Error	`Erro interno do servidor.`	Indica que a API não conseguiu estabelecer conexão com o banco de dados.

Exemplo de Uso

A seguir, um exemplo completo de como consultar uma playlist com o código de acesso a3b4c5.

Requisição:

GET https://tv.midiaindoor.app/painel/api?code=a3b4c5

Resposta de Sucesso Esperada:

{
  "success": true,
  "files": [
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/demo_user/arquivos/videos-da-semana/intro.mp4",
      "type": "video"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/demo_user/arquivos/videos-da-semana/encerramento.mp4",
      "type": "video"
    },
    {
      "url": "https://tv.midiaindoor.app/painel/pastas/demo_user/arquivos/videos-da-semana/logo.png",
      "type": "image"
    }
  ]
}