Retorna a lista de países cadastrados.

Parâmetros da URL

Autenticação

Além da publicKey, a requisição só é aceita se o SERVER_NAME do host bater com um dos domínios permitidos (superaudio.test, superaudio.com.br, portal.superaudio.com.br, api.superaudio.com.br). Não há checagem de sessão nem de header Authorization.

{
    "code": 200,
    "message": null,
    "data": [
        { "id": 1, "name": "Brasil" },
        { "id": 2, "name": "Argentina" }
    ]
}

{
    "code": 403,
    "message": null,
    "data": null
}

Retorna os estados (UF e nome). O parâmetro de país não existe na rota - o controller sempre filtra por country_id = 1 (Brasil), fixo no código.

Parâmetros da URL

Autenticação

Mesma regra de domínio permitido descrita acima em "Listar países".

{
    "code": 200,
    "message": null,
    "data": [
        { "uf": "SP", "name": "São Paulo" },
        { "uf": "RJ", "name": "Rio de Janeiro" }
    ]
}

{
    "code": 403,
    "message": null,
    "data": null
}

Retorna as cidades (id e nome) de um estado específico.

Parâmetros da URL

Autenticação

Mesma regra de domínio permitido descrita acima em "Listar países".

{
    "code": 200,
    "message": null,
    "data": [
        { "id": 3550308, "name": "São Paulo" },
        { "id": 3548500, "name": "Sorocaba" }
    ]
}

{
    "code": 403,
    "message": null,
    "data": null
}

Busca cidades cujo nome contenha o termo informado (case-insensitive, "contains" - não é "starts with"). Limitado a 50 resultados, ordenado por nome.

Atenção: ao contrário dos endpoints acima, esta rota não exige publicKey nem valida o domínio de origem - é pública.

Parâmetros GET (querystring)

{
    "code": 200,
    "message": "Total de cidade encontradas: 2.",
    "data": [
        { "id": 3550308, "name": "São Paulo/SP" },
        { "id": 4125506, "name": "São Paulo do Norte/PR" }
    ],
    "total": 2
}

{
    "code": 400,
    "message": "Não foi enviado o parametro name",
    "data": []
}

Retorna todas as cidades cadastradas na base, sem filtro e sem paginação, ordenadas por nome.

Atenção: assim como a busca por nome, esta rota é pública (sem publicKey e sem validação de domínio). Por não ter limite de resultados, a resposta pode ser bem grande. Diferente dos demais endpoints deste controller, cada item de data traz o registro completo da cidade (id, state_id, uf, name), e data é uma lista simples (array indexado), não um objeto reduzido a id/name.

Parâmetros

Sem parâmetros.

{
    "code": 200,
    "message": "Total de cidade encontradas: 5570.",
    "data": [
        { "id": 3550308, "state_id": 26, "uf": "SP", "name": "São Paulo" },
        { "id": 3509502, "state_id": 26, "uf": "SP", "name": "Campinas" }
    ],
    "total": 5570
}

{
    "code": 0,
    "message": "mensagem da exceção capturada",
    "data": []
}

Baixa uma imagem a partir de uma URL remota e devolve como data URL base64 (usado pelas telas de busca de metadados/capas). Rota pública - Auth->allow(), sem publicKey e sem sessão.

Body

As mensagens de erro abaixo vêm direto da exceção (em inglês, não passam por tradução).

{
    "code": 200,
    "message": null,
    "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."
}

{
    "code": 500,
    "message": "Invalid image URL",
    "data": null
}

{
    "code": 500,
    "message": "Could not fetch image",
    "data": null
}

Em GET, exibe o formulário de e-mail/senha da conta Superaudio Store (ou redireciona para a tela de "já existe integração" se a empresa logada já tiver uma). Em POST/PUT/PATCH, autentica o e-mail/senha contra a Superaudio Store; se válido, cria o vínculo (CompanySuperaudioStore) para a empresa da sessão e redireciona (302) para a tela de sucesso. Se inválido, apenas re-renderiza o formulário com uma mensagem de erro via Flash (sem alterar o status HTTP).

Parâmetros da URL

Body (apenas em POST/PUT/PATCH)

Autenticação

Requer sessão de usuário logado no portal (UserLogged.companyID).

Página HTML exibida após a autorização ser concluída com sucesso (destino do redirect de createApi). Sem parâmetros, sem lógica adicional.

Parâmetros

Sem parâmetros.

Página HTML exibida quando a empresa logada já possui uma integração com a Superaudio Store (destino do redirect de createApi quando já existe registro). Sem parâmetros, sem lógica adicional.

Parâmetros

Sem parâmetros.

Desativa a integração da empresa logada com a Superaudio Store: apaga o registro CompanySuperaudioStore e desativa (exclui logicamente) os tipos de mídia e mídias que haviam sido importados por essa integração.

Parâmetros da URL

Body

Autenticação

Requer sessão de usuário logado no portal (UserLogged.companyID).

{
    "status": "success",
    "message": "SuperaudioStore desabilitado com sucesso.",
    "data": null,
    "code": 200
}

{
    "status": "error",
    "message": "Não foi possível encontrar esta API, tente novamente.",
    "data": null,
    "code": 401
}

{
    "status": "error",
    "message": "Não foi possível desativar esta API, tente novamente.",
    "data": null,
    "code": 500
}