Salvar configurações¶

Exemplos de requisição¶

cURLNode.jsPython

curl --request POST 'https://elo-api-prod.quaggamock.com/plugin-runtime/INSTALLATION_ID/config' \
  --header "Authorization: Bearer $ELO_PLUGIN_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"operation": "settings:write", "value": {"title": "Minutes", "includeEvidence": true}}'

const response = await fetch('https://elo-api-prod.quaggamock.com/plugin-runtime/INSTALLATION_ID/config', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ELO_PLUGIN_TOKEN}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
  "operation": "settings:write",
  "value": {
    "title": "Minutes",
    "includeEvidence": true
  }
})
});
const result = await response.json();
if (!response.ok) throw new Error(result.message);
console.log(result);

import os, json, urllib.request, urllib.error
request = urllib.request.Request(
    "https://elo-api-prod.quaggamock.com/plugin-runtime/INSTALLATION_ID/config",
    data=json.dumps({'operation': 'settings:write', 'value': {'title': 'Minutes', 'includeEvidence': True}}).encode(),
    headers={"Authorization": "Bearer " + os.environ["ELO_PLUGIN_TOKEN"], "Content-Type": "application/json"},
    method="POST",
)
try:
    with urllib.request.urlopen(request, timeout=15) as response:
        print(json.load(response))
except urllib.error.HTTPError as error:
    print(error.code, error.read().decode())

Execução consciente¶

Esta operação altera dados. Copie o exemplo e execute somente após confirmação do usuário. O playground público executa apenas leitura.

POST /plugin-runtime/{installationId}/config

settings:write · https://elo-api-prod.quaggamock.com/plugin-runtime/INSTALLATION_ID/config

Substitui as preferências desta instalação, sem alterar as de outros usuários.

Contrato real

As operações compartilham o endpoint acima e são diferenciadas pelo campo operation no body. Não existe uma rota REST separada para cada nome.

Autenticação¶

Authorization: Bearer <PLUGIN_GRANT> · Content-Type: application/json

Grant de cinco minutos emitido pelo host Elo para esta instalação. A permissão settings:write deve constar no manifesto e ter sido autorizada.

Um grant de reunião permite apenas a reunião vinculada; um grant de configuração não permite ler reuniões.

Parâmetros de caminho¶

Campo	Tipo	Descrição
`installationId`	string	ID da instalação do usuário, não o ID de submissão/manifesto.

Request body¶

Campo	Tipo	Descrição
`operation`	string	settings:write
`value`	object	JSON até 16 KiB; substitui as preferências desta instalação / JSON up to 16 KiB; replaces installation preferences

{
  "operation": "settings:write",
  "value": {
    "title": "Minutes",
    "includeEvidence": true
  }
}

Respostas¶

200 · OK¶

{
  "saved": true
}

400 · Invalid input

{"code": "invalid_input", "message": "Revise os dados enviados.", "issues": []}

401 · Expired or invalid token

{"code": "plugin_token", "message": "A sessão do plugin expirou."}

403 · Permission or meeting scope denied

{"code": "plugin_scope", "message": "O plugin não recebeu esta permissão."}

404 · Installation or meeting not found

{"code": "plugin_missing", "message": "Plugin não encontrado ou desativado."}

Segurança e revogação · Paginação e erros