🔌 Kalkulatur b'xejn API

Ħarsa ġenerali

L-API tuża l-istess matematika eżatta li tuża l-websajt. Ibgħat il-valuri tal-qasam ta' kalkulatur bħala parametri ta' mistoqsija jew JSON u ġib ir-riżultati kkalkulati lura bħala JSON - inkluż kwalunkwe skeda ta' amortizzazzjoni jew dejta ta' tabella li tipproduċi l-kalkulatur.

• 198+ kalkulaturi, kull wieħed b'punt aħħari tiegħu stess
• Ebda ċippa API — aċċess anonimu, b'rata limitata mill-IP
• CORS — Access-Control-Allow-Origin: * (li jistgħu jintużaw min-naħa tal-klijent)
• Limitu tar-rata: 60 talbiet/siegħa għal kull IP (HTTP 429 meta jinqabeż)
• Żbalji huma ħielsa — biss tweġiba b'suċċess (2xx) juża sejħa waħda mill-kwota ta' kull xahar tiegħek.Kull 400, 401, 404, 429 u 500 jiswa inti xejn.

URL bażiku

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

Indiċi — lista ta' kull kalkulatur

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

Jirritorna lista li tinqara mill-magni tal-kalkulaturi kollha b'kull wieħed mill-oqsma (ċavetta, tikketta, tip, default, unità) u ċwievet tar-riżultat - biżżejjed biex jibnu klijent dinamikament. Kull qasam għandu wkoll bandiera meħtieġa — vera għall-ftit oqsma li m'għandhomx default (dati, l-aktar).Ibgħat dawk: ftit kalkulaturi jistgħu jiddeduċu wieħed, il-bqija tweġiba 400 mingħajrha.

Kalkolu — tmexxi kalkulatur wieħed

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

Forma tar-rispons:

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

Kalkulaturi li jagħrfu l-pajjiż (ipoteka, self, taxxa fuq id-dħul, taxxa fuq il-bejgħ...) jaċċettaw ?country=us|uk|ca|au|in|ie|nz|za. Slug mhux magħruf jirritorna 404; pajjiż mhux appoġġjat jew input ħażin jirritorna 400 b'messaġġ utli u l-ispeċifikazzjoni tal-qasam.

Parametri, defaults u żbalji

Ibgħat biss l-oqsma li inti tieħu ħsieb dwar. Kull ħaġa li inti tħalli barra hija mimlija bil-pubblikazzjoni default ta' dak il-qasam - l-istess valur il-paġna kalkulatur pre-miftuħa, sabiex l-API u l-websajt dejjem jirritorna l-istess numri għall-istess inputs. defaults_applied.

Kull ħaġa li l-API ma tistax issolvi b'mod onest hija żball, qatt żero: parametru miktub ħażin, valur tat-tip żbaljat, għażla dropdown mhux magħrufa, jew qasam nieqes li m'għandu l-ebda default (l-oqsma tad-data — data tat-twelid ma tistax tinħass).Kull 400 jissemma l-parametru offensiv u jevoka l-ispeċifikazzjoni sħiħa tal-qasam sabiex klijent jista' jikkoreġi ruħu.

$ 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": [ ... ]
}

Il- /api/v1/ indiċi tippubblika kull qasam ta'l-muftieħ, it-tip, l-unità, default u jekk huwa meħtieġ — biżżejjed biex jibnu klijent li qatt ma jagħraf.

Awtentikazzjoni & pjanijiet

Tista' ssejjaħ l-API mingħajr ebda key — talbiet anonimi huma limitati bir-rata mill-IP. Għal kwota ta' kull xahar ogħla u prevedibbli (u użu kummerċjali), oħloq key fuq il-paġna tal-kont tiegħek u ibgħatha b'wieħed minn tliet modi:

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"

• Ħieles — anonimu (IP rata limitata) jew ċavetta ħielsa ma kwota żgħira kull xahar. Mhux kummerċjali.
• Żviluppatur & mdash; $ 9/mo — 10,000 sejħa/xahar, użu kummerċjali.
• Negozju & mdash; $49/mo — 100,000 sejħa/xahar, throughput prijorità.

X'jgħodd kontra l-kwota tiegħek

Kull żball huwa b’xejn: 400 għal parametru miktub ħażin, valur ħażin jew qasam meħtieġ nieqes, 404 għal slug mhux magħruf, 401 għal ċavetta ħażina, 429, u kull ħaġa li tmur ħażin min-naħa tagħna. Esplora l-kuntratt u iffissa t-talba tiegħek kemm-il darba għandek bżonn — inti huma ċċarġjati għat-tweġibiet, mhux għall-korrezzjonijiet.

Minħabba żbalji huma ħielsa huma rata limitata minflok: jekk wieħed ewlenija jipprovoka aktar minn 200 Meta l-klijent jirċievi 429 tweġibiet rifjutati f'siegħa, huwa jikseb HTTP 429 "too_many_invalid_requests" sakemm is-siegħa rolls fuq. sejħiet b'suċċess qatt ma jgħodd lejn dak, sabiex integrazzjoni xogħol qatt ma se tara dan - huwa biss jaqbad klijent mwaħħla fil-linja retry.

Meta l-kwota ta' kull xahar ta' ċavetta tintuża, l-API tirritorna HTTP 429 b'iżball "quota_exceeded"; ċavetta mhux magħrufa jew inattiva tirritorna HTTP 401. Ara l-pjanijiet sħaħ u jissieħbu fuq il- Prezzijiet paġna.

Eżempji

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

Il-punti aħħarin kollha

Punt aħħari wieħed għal kull kalkulatur. Il-kodiċijiet tal-qasam u l-kodiċijiet tar-riżultat għal kull wieħed huma fil- /api/v1/ indiċi.