Sections de la documentation

Démarrage rapide

Trois étapes : obtenir une clé, appeler le point de terminaison, utiliser le résultat. L'appel à côté de ce texte est un bilan de liaison ; tous les calculateurs fonctionnent de la même façon.

Trois étapes

Obtenez une clé d'API. Une clé gratuite sur votre tableau de bord couvre 5 appels par mois. Pro ($9 par mois) en couvre 100 et API ($19 par mois) 10 000 ; voir les tarifs. Un programme peut obtenir une clé pour son utilisateur sans copier-coller : voir l'autorisation d'appareil.
Appelez le point de terminaison. Envoyez en POST à /api/py/v1/calculate un slug et ses inputs, avec votre clé dans l'en-tête X-API-Key.
Utilisez le résultat. Lisez values par nom de sortie, vérifiez warnings et errors, et conservez provenance si vous devez indiquer comment une valeur a été calculée.

Gardez la clé hors de votre code

Les exemples lisent la clé dans RFTOOLS_API_KEY. La bibliothèque Python lit aussi la clé que rftools login a enregistrée, si bien qu'un script ne la contient jamais.

Shell

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

Entrées et unités

Chaque calculateur reçoit ses entrées dans les unités affichées sur sa page, sous les noms que liste sa référence, avec leurs plages et leurs valeurs par défaut. Envoyez toutes les entrées : la plupart sont obligatoires, et un appel auquel il en manque une est refusé (400) et ne coûte rien ; une entrée dont le calculateur peut se passer prend la valeur par défaut indiquée dans sa référence. La provenance liste chaque entrée à partir de laquelle les valeurs ont été calculées.

Et ensuite

Essayez une requête dans le navigateur avec votre clé.
Erreurs : ce que signifie chaque statut et ce que lève le SDK.
Quotas et limites : le quota mensuel et les limites par 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"
}

Aucune clé n'a été envoyée. keyUrl indique où en obtenir une.