Skip to content
Secciones de la documentación

Inicio rápido

Tres pasos: obtener una clave, llamar al endpoint, usar el resultado. La llamada junto a este texto es un presupuesto de enlace; cualquier calculadora funciona igual.

Tres pasos

  1. Obtenga una clave de API. Una clave gratuita en su panel cubre 5 llamadas al mes. Pro ($9 al mes) cubre 100 y API ($19 al mes) 10.000; consulte los precios. Un programa puede obtener una clave para su usuario sin que este pegue nada: consulte la autorización de dispositivo.
  2. Llame al endpoint. Envíe por POST a /api/py/v1/calculate un slug y sus inputs, con su clave en la cabecera X-API-Key.
  3. Use el resultado. Lea values por el nombre de cada salida, revise warnings y errors, y conserve provenance si necesita indicar cómo se calculó una cifra.

Mantenga la clave fuera de su código

Los ejemplos leen la clave de RFTOOLS_API_KEY. La biblioteca de Python también lee la clave que guardó rftools login, de modo que un script nunca la contiene.

Shell
export RFTOOLS_API_KEY=rfc_…
# or, with the Python library installed:
rftools login

Entradas y unidades

Cada calculadora recibe sus entradas en las unidades que muestra su página, con los nombres que indica su referencia, junto con sus rangos y valores predeterminados. Envíe todas las entradas: la mayoría son obligatorias, y una llamada a la que le falte una se rechaza (400) y no cuesta nada; una de la que la calculadora puede prescindir toma el valor predeterminado que muestra su referencia. La procedencia enumera cada entrada a partir de la cual se calcularon los valores.

Siguientes pasos