Abschnitte der Dokumentation

Schnellstart

Drei Schritte: Schlüssel holen, Endpunkt aufrufen, Ergebnis verwenden. Der Aufruf neben diesem Text ist ein Linkbudget; jeder Rechner funktioniert genauso.

Drei Schritte

Holen Sie sich einen API-Schlüssel. Ein kostenloser Schlüssel aus Ihrem Dashboard deckt 5 Aufrufe pro Monat ab. Pro ($9 pro Monat) deckt 100 ab und API ($19 pro Monat) 10.000; siehe Preise. Ein Programm kann seinem Nutzer einen Schlüssel besorgen, ohne dass dieser etwas einfügt: siehe die Gerätefreigabe.
Rufen Sie den Endpunkt auf. Senden Sie per POST an /api/py/v1/calculate einen slug und dessen inputs, mit Ihrem Schlüssel im Header X-API-Key.
Verwenden Sie das Ergebnis. Lesen Sie values nach dem Namen der Ausgabe, prüfen Sie warnings und errors, und bewahren Sie provenance auf, wenn Sie angeben müssen, wie ein Wert berechnet wurde.

Der Schlüssel gehört nicht in Ihren Code

Die Beispiele lesen den Schlüssel aus RFTOOLS_API_KEY. Die Python-Bibliothek liest auch den Schlüssel, den rftools login gespeichert hat, sodass ein Skript ihn nie enthält.

Shell

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

Eingaben und Einheiten

Jeder Rechner nimmt seine Eingaben in den Einheiten, die seine Seite zeigt, unter den Namen, die seine Referenz aufführt, mit ihren Bereichen und Standardwerten. Senden Sie jede Eingabe: Die meisten sind erforderlich, und ein Aufruf, dem eine davon fehlt, wird abgelehnt (400) und kostet nichts; eine, auf die ein Rechner verzichten kann, erhält den Standardwert, den seine Referenz zeigt. Die Provenienz führt jede Eingabe auf, aus der die Werte berechnet wurden.

Wie es weitergeht

Eine Anfrage im Browser ausprobieren, mit Ihrem Schlüssel.
Fehler: was jeder Status bedeutet und was das SDK auslöst.
Kontingente und Limits: das monatliche Kontingent und die Limits pro Minute.

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "rf-link-budget",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    }
  }'

import rftools

client = rftools.Client()  # reads RFTOOLS_API_KEY, or the key `rftools login` saved

result = client.calculate("rf-link-budget", {
    "txPower": 20,
    "txGain": 2,
    "txCableLoss": 1,
    "frequency": 2400,
    "distance": 0.5,
    "rainFade": 0,
    "atmosphericLoss": 0.5,
    "pointingLoss": 0,
    "extraLossCount": 0,
    "extraLoss1": 0,
    "extraLoss2": 0,
    "extraLoss3": 0,
    "extraLoss4": 0,
    "rxGain": 2,
    "rxCableLoss": 1,
    "rxSensitivity": -90,
    "targetMargin": 10,
})
print(result.values)
print(result.warnings, result.provenance.formula_ref)

const response = await fetch("https://rftools.io/api/py/v1/calculate", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "rf-link-budget",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    }
  }),
});
console.log(response.status, await response.json());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "slug": "rf-link-budget",
	  "inputs": {
	    "txPower": 20,
	    "txGain": 2,
	    "txCableLoss": 1,
	    "frequency": 2400,
	    "distance": 0.5,
	    "rainFade": 0,
	    "atmosphericLoss": 0.5,
	    "pointingLoss": 0,
	    "extraLossCount": 0,
	    "extraLoss1": 0,
	    "extraLoss2": 0,
	    "extraLoss3": 0,
	    "extraLoss4": 0,
	    "rxGain": 2,
	    "rxCableLoss": 1,
	    "rxSensitivity": -90,
	    "targetMargin": 10
	  }
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("RFTOOLS_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

application/json

{
  "slug": "rf-link-budget",
  "values": {
    "fspl": 94.03140814283587,
    "eirp": 21,
    "rxPower": -72.53140814283587,
    "linkMargin": 17.468591857164128,
    "maxRangeKm": 3.73593745752468,
    "totalAdditionalLoss": 0.5,
    "wavelength": 124.91352416666666,
    "fresnelRadius": 3.951479535671839,
    "maxRangeAtTarget": 1.181407156171655
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:rf-link-budget",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Friis, \"A Note on a Simple Transmission Formula\" (1946)",
    "assumptions": [],
    "validRange": {
      "status": "inside",
      "bounds": {
        "txPower": {
          "min": -30,
          "max": 100,
          "unit": "dBm"
        },
        "txGain": {
          "min": -30,
          "max": 60,
          "unit": "dBi"
        },
        "txCableLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "frequency": {
          "min": 0.1,
          "max": 1000000,
          "unit": "MHz"
        },
        "distance": {
          "min": 0.001,
          "max": 1000000,
          "unit": "km"
        },
        "rainFade": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "atmosphericLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "pointingLoss": {
          "min": 0,
          "max": 10,
          "unit": "dB"
        },
        "extraLossCount": {
          "min": 0,
          "max": 4,
          "unit": ""
        },
        "extraLoss1": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss2": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss3": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss4": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "rxGain": {
          "min": -30,
          "max": 60,
          "unit": "dBi"
        },
        "rxCableLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "rxSensitivity": {
          "min": -160,
          "max": 0,
          "unit": "dBm"
        },
        "targetMargin": {
          "min": 0,
          "max": 60,
          "unit": "dB"
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

{
  "detail": "An API key is required. Get a free key at https://rftools.io/dashboard/?newKey=1.",
  "errorKind": "invalid_request",
  "keyUrl": "https://rftools.io/dashboard/?newKey=1"
}

Es wurde kein Schlüssel gesendet. keyUrl gibt an, wo Sie einen erhalten.