SmartMSX

API de parceiro: enviar a lista à TV pelo MAC

Para donos de painel. Com estas rotas, o painel envia a lista do cliente para a TV com o app SmartMSX, confere o MAC e consulta o código do servidor. O endereço base é https://smartmsx.com/api.

1. Regras comuns

  • Endereço: https://smartmsx.com/api/<rota>. A caixa não importa, e a rota também vale sem o /api e com barra no fim.
  • Corpo: JSON, formulário (urlencoded) ou multipart. Teto de 4096 bytes; acima disso o corpo é ignorado e a rota responde que falta o campo.
  • Resposta: sempre o envelope {"error": <verdadeiro ou falso>, "message": <texto ou objeto>, "status": <número>}, exceto em free_dns/code.
  • Token: no cabeçalho Authorization: Bearer <token>. O token sem a palavra Bearer também vale; outro esquema conta como sem token.
  • Erros gerais: 404 Route not found; 405 Method not allowed (com o cabeçalho Allow); 429 Too many requests; 502 Service unavailable, try again.

2. Entrar pela chave da TV (login_by_mac)

POST, sem token. Campos: mac (obrigatório) e a chave do aparelho em key, device_key, deviceKey, code_app, app_code ou device_code. log_by_mac é o mesmo que login_by_mac.

curl -X POST https://smartmsx.com/api/login_by_mac \
  -H 'content-type: application/json' \
  -d '{"mac":"00:1A:2B:3C:4D:5E","key":"123456"}'

Sucesso: 200 com o token de painel em message (painel.<carga>.<assinatura>), válido por 60 minutos (valor do admin). Erros: 400 Invalid format (MAC inválido), 404 Device not found, 400 Wrong key (também com a chave em branco).

3. Enviar a lista (playlist_with_mac)

POST. Campos: mac e, ou url com name, ou o código do servidor (code, server_code, dns_code ou codigo) com usuário (username, user ou usuario) e senha (password, pass ou senha). A chave do aparelho é opcional. O token é opcional e só liga o envio a uma consulta do código feita antes.

curl -X POST https://smartmsx.com/api/playlist_with_mac \
  -H 'content-type: application/json' \
  -d '{"mac":"00:1A:2B:3C:4D:5E","name":"Lista da sala","url":"http://servidor:80/get.php?username=cliente&password=senha&type=m3u_plus"}'

Sucesso: 200 com message {id, name, url, deviceId, added_by_web: true, is_protected: false, activation: {status, expires, playlist_expires: null}}; status é active, own ou pending. O name é cortado em 40 caracteres e a url aceita até 2048. Uma lista protegida por PIN é aceita, mas o PIN é ignorado: is_protected sai sempre false.

4. Enviar pelo código do servidor com o token (playlist/code)

POST com o token de painel do login_by_mac. Campos: código, usuário e senha (os mesmos nomes do item 3). O mac é opcional e, se vier, tem de ser o do token. A url é ignorada.

curl -X POST https://smartmsx.com/api/playlist/code \
  -H 'authorization: Bearer painel.<carga>.<assinatura>' \
  -H 'content-type: application/json' \
  -d '{"code":"1234","username":"cliente","password":"senha"}'

Sucesso: o mesmo corpo do item 3. Erros próprios: 401 Forbidden (sem token), 401 invalid token, 403 mac does not match the token, 400 code is required, username is required ou password is required.

5. Conferir o MAC (validate_mac)

GET, sem token, com ?mac=.

curl 'https://smartmsx.com/api/validate_mac?mac=00:1A:2B:3C:4D:5E'

Sucesso: 200 com message {payed, free_trial, mac, auth_type: "device_key", id, model, os_version: null, app_version: null}. Erros: 404 Device is not found; 500 "mac" is required e 500 Invalid format (status 500 por compatibilidade com os painéis).

6. Consultar o código do servidor (admin_server/code)

GET com o token de painel e ?code=.

curl 'https://smartmsx.com/api/admin_server/code?code=1234' \
  -H 'authorization: Bearer painel.<carga>.<assinatura>'

Sucesso: 200 com message {id, host, name, external_api: "", device_count: 0, device_limit: null, code, reseller_id: null, createdAt, updatedAt}. A consulta liga o token ao servidor por 10 minutos, para o envio seguinte. Erros: 400 Server not found; 500 "code" is required; 500 "code" is not allowed to be empty. Token ausente ou torto responde HTTP 200 com {"error": true, "code": 401, "message": "Forbidden"} ou "jwt malformed".

7. DNS livre (free_dns/code)

GET. A rota existe, mas responde sempre 403 {"error": "Feature is disabled."}, fora do envelope.

8. Respostas do envio

  • 400 mac is required, url is required, name is required, username is required, password is required.
  • 400 Invalid format, url must contain username and password, url is invalid, Wrong key.
  • 404 Device not found: a TV ainda não abriu o app SmartMSX.
  • 403 Server code not found: o código não é de nenhum servidor cadastrado.
  • 409 This account is already on this device with a different password: a mesma conta já está na TV com outra senha.
  • 409 Playlist limit reached: a TV chegou ao número máximo de listas.

9. Limites

  • Por origem (endereço IP; no IPv6, a faixa /64): 300 pedidos em 10 minutos, contados à parte para envio e consulta.
  • Por origem e MAC: 10 envios em 10 minutos.
  • Por TV: 5 envios de painel em 60 minutos.
  • Chave do aparelho no login_by_mac: 5 tentativas por MAC e 200 por origem em 15 minutos.
  • Consulta do código: 30 por minuto no total.
  • Passado o limite, a resposta é 429 Too many requests. Os números são valores do admin e podem mudar.