🔌 Ingyenes számológép API

Áttekintés

Az API ugyanazt a matematikát futtatja, mint a weboldal. Küldjön egy számológép mezőértékeit lekérdezési paraméterek vagy JSON és kap a számított eredmények vissza, mint a JSON · beleértve az amortizációs menetrendet vagy diagram adatok a számológép termel.

• 198+ számológépek, amelyek mindegyike saját végponttal rendelkezik
• Nincs API-kulcs — névtelen hozzáférés, az IP-ben korlátozott arány
• CORS — Access-Control-Allow-Origin: * (használható kliensoldal)
• Arányhatár: 60 Kérések/óra IP-enként (HTTP 429, ha túllépték)
• A hibák ingyenesek — Csak egy sikeres (2xx) válasz használ egy hívást a havi kvóta. Minden 400, 401, 404, 429 és 500 kerül semmi.

Alap URL

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

Index ★ minden számológép listája

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

Visszaadja a gépileg olvasható listát az összes számológépről mindegyik mezővel (kulcs, címke, típus, alapértelmezett, egység) és eredmény kulcsokkal ~ elég ahhoz, hogy dinamikusan építsen egy klienst. Minden mezőn van egy szükséges zászló • igaz a kevés mező, hogy nincs alapértelmezett (dátumok, többnyire). Küldje el azokat: néhány számológépek is tartalmaz egyet, a többi válasz 400 nélkül.

Compute — run one calculator

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

Válaszforma:

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

Ország-ismertető számológépek (mortgage, loan, erey-tax, sales-tax...) elfogadnak ?country=us|uk|ca|au|in|ie|nz|za. Ismeretlen golyó visszatér 404; támogatott ország vagy rossz bevitel visszatér 400 egy hasznos üzenetet és a mező spec.

Paraméterek, alapértelmezések és hibák

Csak a fontos mezőket küldd el. Bármi, amit kihagysz, az a mező publikált alapértelmezett ~ ugyanazzal az értékkel van ellátva, mint a számológép oldal előtöltése, így az API és a weboldal mindig ugyanazokat a számokat adja vissza ugyanazokért a bemenetekért. Minden válasz felsorolja, hogy mit töltött be. defaults_applied.

Bármi, amit az API nem tud őszintén megoldani, az hiba, soha nem nulla: egy hibás paraméter, egy hibás típusú érték, egy ismeretlen leesési opció vagy egy hiányzó mező, amely nem alapértelmezett (a dátum mezők • a születési dátum nem lehet kitalálni). 400-szor a sértő paramétert, és visszhangozza a teljes mező spec, hogy egy ügyfél képes kijavítani magát.

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

A /api/v1/ Az index minden mező kulcsát, típusát, egységét, alapértelmezését és azt teszi közzé, hogy szükséges-e ~ elég ahhoz, hogy olyan klienst építsen, aki sosem találgat.

Hitelesítés és tervek

Felhívhatja az API-t kulcs nélkül • névtelen kérések az IP-vel korlátozottan. Egy magasabb, kiszámítható havi kvóta (és kereskedelmi felhasználás) esetén hozzon létre egy kulcsot a fiókoldalon, és küldje el a következő három mód egyike:

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"

• Szabad — anonim (IP-díjkorlátozott) vagy ingyenes kulcs egy kis havi kvótával. Nem kereskedelmi.
• Fejlesztő — $9/mo — 10 000 hívás/hó, kereskedelmi felhasználás.
• Üzleti — $49/mo — 100 000 hívás/hó, elsődleges feladat.

Mi számít a kvótádnak?

Csak egy sikeres válasz igen. Egy 2xx = egy hívás. Minden hiba ingyenes: egy 400-as egy hibás paraméter, egy rossz érték vagy egy hiányzó szükséges mező, egy 404-es ismeretlen lövedék, egy 401-es egy rossz kulcs, egy 429, és minden, ami rosszul működik a mi oldalunkon. Fedezze fel a szerződést, és javítsa a kérését, ahányszor szüksége van • akkor számlázzák a válaszok, nem a javítások.

Mivel a hibák ingyenesek, ezek a díjak helyett korlátozottak: ha egy kulcs több mint 200 egy óra alatt visszautasította a válaszokat, így a HTTP 429 "too_many_invalid_requests" lesz, amíg az óra el nem múlik. A sikeres hívások nem számítanak erre, így a működő integráció soha nem fogja észre, hogy • csak egy ügyfélnek akadt egy retry hurok.

Ha a kulcs havi kontingensét használják fel, az API "kvóta_exceeded" hiba esetén HTTP 429 értéket ad vissza; egy ismeretlen vagy inaktív kulcs értéke HTTP 401. Lásd a teljes terveket és regisztrálni a Árak oldal.

Példák

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

Összes végpont

Egy végpont számológépenként. A mező kulcsok és eredmény kulcsok minden van a /api/v1/ index.