Como Criar um Totem de Autoatendimento via API

Neste tutorial, você vai criar um totem de autoatendimento usando a API REST. O processo consiste em montar o JSON com os dados da tela, enviar para o endpoint de criação e validar o retorno com a screen_key. Para consultar a referência completa dos endpoints disponíveis, acesse a documentação oficial da API.

I – Definindo os dados do totem

A requisição aceita um JSON no corpo. O campo obrigatório é code_tela. Os demais são opcionais.

{
  "code_tela": "TOTEM-PRINCIPAL",
  "order": 1,
  "is_default": true,
  "is_appointment_search": false,
  "multiple_services": true,
  "type_screen": "service",
  "logo": "https://exemplo.com/imagens/logo.png",
  "icon": "https://exemplo.com/imagens/icone.png",
  "background_color": "#FFFFFF",
  "color": "#1E88E5"
}

Campos do corpo da requisição:

• code_tela (obrigatório): nome da tela. Máximo de 20 caracteres.
• order (opcional): número da etapa/exibição. Valores entre 0 e 32767.
• is_default (opcional): define se o totem é a tela padrão.
• is_appointment_search (opcional): habilita busca de agendamentos no totem.
• multiple_services (opcional): permite selecionar múltiplos serviços para a mesma senha.
• type_screen (opcional): tipo de tela. Valores permitidos:

Valor	Significado
service	Selecionar serviços
group	Selecionar grupos

• logo (opcional): URL da logo exibida no totem.
• icon (opcional): URL do ícone da tela.
• background_color (opcional): cor de fundo. Máximo de 20 caracteres.
• color (opcional): cor de customização da tela. Máximo de 20 caracteres.

II – Enviando a requisição

Envie uma requisição HTTP POST para:

POST https://painel.meuatendimentovirtual.com.br/api/v1/totens/

Configure os seguintes cabeçalhos, usando a chave de API disponível nas configurações da plataforma:

• accept: application/json
• Authorization: Bearer <sua-chave-de-api>
• Content-Type: application/json

Exemplo com cURL:

curl -X POST https://painel.meuatendimentovirtual.com.br/api/v1/totens/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "code_tela": "TOTEM-PRINCIPAL",
  "order": 1,
  "is_default": true,
  "is_appointment_search": false,
  "multiple_services": true,
  "type_screen": "service",
  "logo": "https://exemplo.com/imagens/logo.png",
  "icon": "https://exemplo.com/imagens/icone.png",
  "background_color": "#FFFFFF",
  "color": "#1E88E5"
}'

Exemplo em Python:

import requests

url = "https://painel.meuatendimentovirtual.com.br/api/v1/totens/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "code_tela": "TOTEM-PRINCIPAL",
    "order": 1,
    "is_default": True,
    "is_appointment_search": False,
    "multiple_services": True,
    "type_screen": "service",
    "logo": "https://exemplo.com/imagens/logo.png",
    "icon": "https://exemplo.com/imagens/icone.png",
    "background_color": "#FFFFFF",
    "color": "#1E88E5"
}

response = requests.post(url, json=data, headers=headers)
print(response.status_code)
print(response.json())

III – Verificando a resposta

Uma criação bem-sucedida retorna o status 201 Created com os dados do totem:

{
  "screen_key": "19cdcce6-25f0-4000-836f-601f4a7e3280",
  "code_tela": "TOTEM-PRINCIPAL",
  "order": 1,
  "is_default": true,
  "is_appointment_search": false,
  "multiple_services": true,
  "type_screen": "service",
  "services": [],
  "services_groups": [],
  "logo": "https://exemplo.com/imagens/logo.png",
  "icon": "https://exemplo.com/imagens/icone.png",
  "background_color": "#FFFFFF",
  "color": "#1E88E5"
}

O campo screen_key identifica o totem criado e pode ser usado em integrações ou atualizações posteriores da tela.

IV – Erros comuns

• 400 Bad Request: verifique se code_tela foi enviado, se type_screen usa apenas service ou group, e se os campos respeitam os limites de tamanho.
• 401 Unauthorized: a chave de API está ausente ou incorreta no cabeçalho Authorization.

---

Para preparar os serviços antes de vincular ao totem, veja Como Criar um Serviço via API. Se sua tela usar grupos, consulte Como Criar um Grupo de Serviços via API. Para configuração pela interface da plataforma, acesse Como Configurar Telas de Autoatendimento (Totens).