Como Criar um Serviço via API

Neste tutorial, você vai criar um serviço de atendimento na plataforma usando a API REST do Meu Atendimento Virtual. O serviço criado pode ser usado em filas e telas de autoatendimento, com identificação por nome, código e cor. Para consultar a referência completa dos endpoints disponíveis, acesse a documentação oficial da API.

I – Definindo os dados do serviço

A requisição aceita um JSON no corpo. Os campos obrigatórios são name e code. Os demais são opcionais.

{
  "order": 10,
  "name": "Consulta Agendada",
  "code": "CAG",
  "icon": "https://exemplo.com/icons/consulta.png",
  "color": "#1E88E5"
}

Campos do corpo da requisição:

• order (opcional): ordem de exibição do serviço na tela. Quanto maior o valor, maior a prioridade visual na lista.
• name (obrigatório): nome do serviço. Máximo de 50 caracteres.
• code (obrigatório): código de até 3 caracteres, usado para identificação da senha impressa.
• icon (opcional): URL de imagem para representar o serviço na tela.
• color (opcional): cor associada ao serviço. 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/servicos/

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/servicos/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "order": 10,
  "name": "Consulta Agendada",
  "code": "CAG",
  "icon": "https://exemplo.com/icons/consulta.png",
  "color": "#1E88E5"
}'

Exemplo em Python:

import requests

url = "https://painel.meuatendimentovirtual.com.br/api/v1/servicos/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "order": 10,
    "name": "Consulta Agendada",
    "code": "CAG",
    "icon": "https://exemplo.com/icons/consulta.png",
    "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 serviço:

{
  "key": "srv123",
  "order": 10,
  "name": "Consulta Agendada",
  "code": "CAG",
  "priority": "normal",
  "search_field": "",
  "form_fields": [
    {
      "field_name": "cpf",
      "required": false
    }
  ],
  "icon": "https://exemplo.com/icons/consulta.png",
  "color": "#1E88E5"
}

O campo key identifica o serviço criado e pode ser usado em integrações e configurações relacionadas.

IV – Erros comuns

• 400 Bad Request: verifique se name e code foram enviados e se code possui no máximo 3 caracteres.
• 401 Unauthorized: a chave de API está ausente ou incorreta no cabeçalho Authorization.

---

Se você ainda não criou a estrutura de grupos, veja Como Criar um Grupo de Serviços via API. Para configurar serviços e filas pela interface da plataforma, consulte Como Configurar Serviços/Filas.