API HTTP local

A API HTTP local é um servidor que só atende no próprio computador (127.0.0.1). É ela que o plugin do InDesign usa, e serve também para scripts e outros programas em qualquer linguagem. A referência de cada rota está em Referência da API HTTP.

Iniciar#

Há dois servidores com a mesma API:

NeoMath --servidor
neomath servidor --porta 8790

O instalador pode deixar o NeoMath --servidor iniciando com o sistema (ligado por padrão no Windows e no Linux). Ele não abre janela e usa a pasta do usuário como raiz.

Porta e token: servidor.json#

Ao iniciar, o servidor grava o servidor.json, com permissão só do usuário:

{ "porta": 8790, "token": "9f2c…", "url": "http://127.0.0.1:8790", "pid": 4242, "versao": "0.2.0" }

Os clientes leem a porta e o token desse arquivo.

Autenticação#

Todo pedido, menos GET /v1/saude, leva o token:

Authorization: Bearer <token>

Também valem X-NeoMath-Token: <token> e ?token=<token> na URL, para quem não consegue mandar cabeçalhos.

Exemplos#

TOKEN=$(python3 -c "import json,os;print(json.load(open(os.path.expanduser('~/.local/state/neomath/servidor.json')))['token'])")
curl -s http://127.0.0.1:8790/v1/saude
curl -s -H "Authorization: Bearer $TOKEN" -X POST http://127.0.0.1:8790/v1/svg -d '{"mathml":"\\frac{a}{b}"}' -o eq.svg
curl -s -H "Authorization: Bearer $TOKEN" -X POST "http://127.0.0.1:8790/v1/eps?bruto=1" -d '{"mathml":"\\ce{2 H2 + O2 -> 2 H2O}","opcoes":{"cor":[0,100,100,0]}}' -o reacao.eps

const r = await fetch("http://127.0.0.1:8790/v1/eps", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: `Bearer ${token}` },
  body: JSON.stringify({ mathml: "x^2 + y^2 = r^2", opcoes: { cor: "#1F4E79" } }),
});
const g = await r.json();
console.log(g.largura_pt, g.altura_pt, g.linha_base_pt);

import json, os, urllib.request
s = json.load(open(os.path.expandvars(r"%LOCALAPPDATA%\NeoMath\servidor.json")))
pedido = urllib.request.Request(s["url"] + "/v1/png?dpi=600", data=json.dumps({"mathml": r"\sqrt{2}"}).encode(),
                                headers={"Authorization": "Bearer " + s["token"], "Content-Type": "application/json"})
open("raiz.png", "wb").write(urllib.request.urlopen(pedido).read())

O campo mathml aceita MathML ou LaTeX: o NeoMath reconhece sozinho.

Opções de saída#

Respostas e erros#

{ "status": "erro", "codigo": "token", "erro": "token ausente ou inválido …" }

Fluxo de edição#

É assim que o InDesign mantém as equações em dia:

Segurança#

• Escuta só em 127.0.0.1 e recusa outro Host.
• Pedidos de navegador só são aceitos das origens passadas em --origem.
• Rotas que tocam o disco ficam presas à pasta --raiz (com links simbólicos resolvidos).
• As rotas antigas sem /v1 continuam funcionando para clientes antigos, também com token.