🔌 Laisvas skaičiaviklis API

Apžvalga

API veikia tiksliai tą pačią matematiką svetainėje naudoja. Siųsti skaičiuotuvo lauko vertes, kaip užklausos parametrai arba JSON ir gauti kompiuterinių rezultatų atgal kaip JSON – įskaitant bet amortizacijos tvarkaraštis arba diagramos duomenis skaičiuotuvas sukuria.

• 198+ skaičiuotuvai, kiekvienas su savo vertinamąja baigtimi
• Nr API raktas — anonimiška prieiga, palūkanų normos ribojamos IP
• CORS — Access-Control-Allow-Origin: * (naudojama kliento pusė)
• Normos riba: 60 užklausos per IP (perskaičiuojant HTTP 429)
• Klaidos yra laisvos — tik sėkmingas (2xx) atsakymas naudoja vieną skambutį iš savo mėnesinės kvotos.Kiekvienas 400, 401, 404, 429 ir 500 jums nieko.

Pagrindinis URL

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

Indeksas – sąrašas

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

Grįžta į mašininio nuskaitymo sąrašą visų skaičiuotuvų su kiekvieno laukų (raktas, etiketė, tipas, numatytoji, vienetas) ir rezultatų raktai – pakankamai, kad dinamiškai sukurti klientą. Kiekvienas laukas taip pat turi reikiamą vėliavą — tinka keliems laukams, kurie neturi numatyto (datos, daugiausia). Siųsti tuos: keletas skaičiuotuvų gali įdėti vieną, likusių atsakyti 400 be jo.

Apskaičiuoti – paleisti vieną skaičiuoklę

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

Atsako forma:

{
  "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"]
}

Įrangos skaičiuotuvai (automatiniai, paskolos, pajamų-mokesčiai, pardavimo-mokesčiai...) ?country=us|uk|ca|au|in|ie|nz|za. Nežinomas šliaužimas grįžta 404; nepalaikoma šalis arba blogas indėlis grąžinami 400 su naudingu pranešimu ir lauke spec.

Parametrai, numatytoji vertė ir klaidos

Siųsti tik jums rūpimus laukus. Viskas, ką išvykstate, pildoma to lauko paskelbtu numatytuoju — ta pati vertė, kurią skaičiuoklė užpildo iš anksto, todėl API ir svetainė visada grąžina tuos pačius numerius tiems patiems įėjimams. Kiekvienas atsakymas į sąrašą, kurį ji užpildė pagal defaults_applied.

Bet koks API negali sąžiningai išspręsti – tai klaida, niekada nėra nulis: klaidingas parametras, klaidingo tipo reikšmė, nežinoma nukritimo parinktis, arba trūkstamas laukas, kuris neturi numatytojo (datos laukai – gimimo data negali būti atspėti). Kiekvienas 400 pavadinimų užgaulio parametras ir atkartoja visą lauką, kad klientas galėtų pataisyti save.

$ 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/ rodyklė skelbia kiekvieną lauką raktą, tipas, vienetas, nutylėjimas ir ar ji yra būtina — pakankamai sukurti klientą, kad niekada spėti.

Autentikacijos & amp; planai

Galite skambinti API be rakto visai – anoniminiai prašymai yra ribojamas IP. Dėl didesnės, nuspėjamos mėnesio kvotos (ir komercinio naudojimo), sukurti raktą savo sąskaitos puslapyje ir siųsti jį vienas iš trijų būdų:

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"

• Laisva — anonimiškas (IP norma apribota) arba nemokamas raktas su maža mėnesio kvota. Nekomercinis.
• Programuotojas & mdash; $9/mo — 10 000 skambučių per mėnesį, komercinis naudojimas.
• Verslo & mdash; $49/mo — 100 000 skambučių per mėnesį, pirmumo pralaidumas.

Kas priklauso nuo jūsų kvotos

Tik sėkmingas atsakymas. Vienas 2xx = vienas skambutis. Kiekviena klaida yra nemokama: 400 klaidingai parametrui, bloga vertė ar trūkstamas reikalingas laukas, 404 nežinomam šliaužimui, 401 blogam raktui, 429, ir viskas, kas vyksta mūsų pusėje. Ištirkite sutartį ir pataisykite savo užklausą tiek kartų, kiek jums reikia – jums yra mokama už atsakymus, o ne už pataisymus.

Kadangi klaidos yra be, jos yra ribojamos norma: jei vienas raktas provokuoja daugiau nei 200 atmestus atsakymus per valandą, ji gauna HTTP 429 "too_many_invalid_requests" iki valandos ritiniais per. Sėkmingi skambučiai niekada neskaičiuoja į tai, todėl darbo integracija niekada pamatysi, kad – ji tik sugauti klientą įstrigęs į vėlyvojo kilpa.

Kai naudojama rakto mėnesio kvota, API grąžina HTTP 429 su klaida "kvota_ viršijama"; nežinomas arba neaktyvus raktas grįžta HTTP 401. Žr. išsamius planus ir užsiregistruoti Kainos puslapis.

Pavyzdžiai

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}'

Visi tyrimo tikslai

Vienas rezultatas vienam skaičiuoklė. Lauko klavišai ir rezultatų raktai kiekvienam yra /api/v1/ Rodyklė.