🔌 Tasuta kalkulaator API

Ülevaade

API kasutab täpselt sama matemaatikat, mida veebileht kasutab. Saada kalkulaatori välja väärtused päringu parameetritena või JSON ja saada arvutatud tulemused tagasi JSON ~ sealhulgas kõik amortisatsiooni ajakava või diagrammi andmed, mida kalkulaator toodab.

• 198+ kalkulaatorid, millel on oma tulemusnäitaja
• API võti puudub — anonüümne juurdepääs, IP-ga piiratud määr
• CORS — Access-Control-Allow-Origin: * (kasutatav kliendipoolne)
• Hinnapiirang: 60 taotlused/tunnid intellektuaalomandi kohta (HTTP 429 ületamisel)
• Vead on tasuta — Ainult edukas (2xx) vastus kasutab ühte kõnet oma igakuise kvoodi. Iga 400, 401, 404, 429 ja 500 maksab teile midagi.

Baas- URL

https://calculator.free/api/v1/

Indeks ~ loend iga kalkulaator

GET https://calculator.free/api/v1/

Tagastab kõigi kalkulaatorite masinloetava nimekirja iga väljaga (võti, silt, tüüp, vaikimisi seade) ja tulemuse võtmetega ~ piisavalt, et ehitada klient dünaamiliselt. Iga väli kannab ka nõutud lipu ® true mõne väljad, mis ei ole vaikimisi (kuupäevad, enamasti). Saada need: paar kalkulaatorid võivad saada üks, ülejäänud vastus 400 ilma selleta.

Arvuta ~ käivita üks kalkulaator

GET  https://calculator.free/api/v1/<slug>/?field=value&field=value
POST https://calculator.free/api/v1/<slug>/     (JSON or form body)

Reageerimisskeem:

{
  "ok": true,
  "slug": "mortgage",
  "country": "us",
  "inputs":   { ... the values actually computed with ... },
  "results":  { ... computed result keys ... },
  "schedule": { "columns": [...], "rows": [...] } | null,
  "chart":    { "type": "pie", "slices": [...] } | null,
  "defaults_applied": ["tax", "insurance"]
}

Riigiteadlikud kalkulaatorid (hüpoteek, laen, tulumaks, müügimaks...) aktsepteerivad ?country=us|uk|ca|au|in|ie|nz|za. Tundmatu nälkjas tagastab 404; toetamata riik või halb sisend tagastab 400 kasuliku sõnumi ja välja spetsifikatsiooniga.

Parameetrid, vaikeväärtused ja vead

Saada ainult väljad, millest hoolid. Kõik, mis välja jätad, täidetakse selle välja vaikimisi ® sama väärtusega kalkulaatori lehe eeltäitmine, nii et API ja veebileht tagastavad alati samad numbrid samade sisendite korral. Iga vastus loetleb, mida see on täitnud defaults_applied.

Kõik, mida API ei suuda ausalt lahendada, on viga, mitte kunagi null: valesõnaline parameeter, vale tüübi väärtus, tundmatu rippmenüü või puuduva väljaga, millel ei ole vaikimisi vaikimisi (kuupäeva väljad ~ sünniaega ei saa ära arvata). Iga 400 nime all on solvav parameeter ja see näitab välja täistäpsust, et klient saaks ennast parandada.

$ curl "https://calculator.free/api/v1/mortgage/?price=350000&rate=6.5&term=30"
{
  "ok": false,
  "error": "unknown_parameter",
  "message": "Unknown parameter 'term' for calculator 'mortgage'. Did you mean 'years'? ...",
  "unknown_parameters": ["term"],
  "did_you_mean": { "term": "years" },
  "valid_parameters": ["down", "extra", "extra_onetime", "extra_yearly", "hoa",
                       "insurance", "other", "pmi", "price", "rate", "tax", "years"],
  "fields": [ ... ]
}

• /api/v1/ indeks avaldab iga välja võtme, tüübi, ühiku, vaikimisi ja kas see on vajalik ~ piisavalt, et ehitada klient, kes kunagi ei arva.

Autentimine ja plaanid

Võite helistada API ilma võti üldse ~ anonüümsete taotluste on määr piiratud IP. Suurema, prognoositav igakuine kvoot (ja kaubandusliku kasutamise), luua võti oma konto lehele ja saata see ühel kolmest viisist:

GET  https://calculator.free/api/v1/mortgage/?price=350000&key=YOUR_KEY
curl -H "Authorization: Bearer YOUR_KEY" "https://calculator.free/api/v1/bmi/?units=metric&height=180&weight=80"
curl -H "X-Api-Key: YOUR_KEY"           "https://calculator.free/api/v1/bmi/?units=metric&height=180&weight=80"

• Vaba — anonüümne (IP-määr piiratud) või tasuta võti väikese igakuise kvoodiga. Mittekaubanduslik.
• Arendaja — $9/mo — 10 000 kõnet/kuus, kommertskasutus.
• Äri — $49/mo — 100 000 kõnet kuus, prioriteetne jõudlus.

Mis on sinu kvoodist parem?

Ainult edukas vastus. Üks 2xx = üks kõne. Iga viga on tasuta: 400 valekirjaga parameetri, halva väärtuse või puuduva vajaliku välja, 404 tundmatu nälkja, 401 halva võtme, 429, ja kõik, mis läheb valesti meie poolel. Uurige lepingut ja määrata oma taotluse nii palju kordi kui vajate ~ sa oled arve vastuste, mitte paranduste.

Kuna vead on tasuta, siis on need hoopis määra piiranud: kui üks võti tekitab rohkem kui 200 tagasi lükatud vastused tunni jooksul, see saab HTTP 429 "liiga_many_invalid_requests" kuni tund veereb üle. Edukad kõned kunagi lugeda selle poole, nii et töö integratsiooni kunagi näha seda ~ see ainult saagi klient kinni uuesti ring.

Kui key kuukvoot on kasutusel API tagastab HTTP 429 veaga "quote_ exceed"; tundmatu või passiivne võti tagastab HTTP 401. Vt täielikke plaane ja registreeruda Hinnakujundus lehekülg.

Näited

curl

curl "https://calculator.free/api/v1/mortgage/?price=350000&down=70000&rate=6.9&years=30"

JavaScript fetch()

const r = await fetch(
  "https://calculator.free/api/v1/bmi/?" + new URLSearchParams({
    units: "metric", height: "180", weight: "80"
  }));
const { results } = await r.json();
console.log(results.bmi, results.category);

Python

import requests

r = requests.get("https://calculator.free/api/v1/mortgage/",
                 params={"price": 350000, "down": 70000,
                         "rate": 6.9, "years": 30},
                 headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["results"])

POST JSON

curl -X POST "https://calculator.free/api/v1/income-tax/?country=uk" \
  -H "Content-Type: application/json" \
  -d '{"income": 60000}'

Kõik tulemusnäitajad

Üks tulemusnäitaja kalkulaatori kohta. Välja võtmed ja tulemuse klahvid iga on /api/v1/ Indeks.