API HTTP local

La API HTTP local es un servidor que solo atiende en el propio equipo (127.0.0.1). Es la que usa el plugin de InDesign, y sirve también para scripts y otros programas en cualquier lenguaje. La referencia de cada ruta está en Referencia de la API HTTP.

Iniciar#

Hay dos servidores con la misma API:

NeoMath --servidor
neomath servidor --porta 8790

El instalador puede dejar NeoMath --servidor iniciándose con el sistema (activado de forma predeterminada en Windows y Linux). No abre ventana y usa la carpeta del usuario como raíz.

Puerto y token: servidor.json#

Al iniciar, el servidor escribe el servidor.json, con permiso solo para el usuario:

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

Los clientes leen el puerto y el token de ese archivo.

Autenticación#

Toda petición, salvo GET /v1/saude, lleva el token:

Authorization: Bearer <token>

También valen X-NeoMath-Token: <token> y ?token=<token> en la URL, para quien no puede enviar cabeceras.

Ejemplos#

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" }),
});
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())

El campo mathml acepta MathML o LaTeX: NeoMath lo reconoce solo.

Opciones de salida#

Respuestas y errores#

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

Flujo de edición#

Así mantiene InDesign las ecuaciones al día:

Seguridad#

• Escucha solo en 127.0.0.1 y rechaza otro Host.
• Las peticiones de navegador solo se aceptan de los orígenes pasados en --origem.
• Las rutas que tocan el disco quedan limitadas a la carpeta --raiz (con enlaces simbólicos resueltos).
• Las rutas antiguas sin /v1 siguen funcionando para clientes antiguos, también con token.