🔌 Хэмжих хэрэгсэл

Тодорхойлолт

API нь вебсайтын ашигладаг математиктэй яг адилхан үйлдлийг гүйцэтгэнэ. Тоон гарын үсэгний талбарын утга, асуултын параметр эсвэл JSON- ийг илгээж, тооцоолсон дүнг JSON- ээр авч болно. Энэ нь тооцоолуурын гаргасан аливаа амортизацийн төлөвлөгөө, графикийн мэдээллийг багтаасан болно.

• 198+ тооцоолуурууд, бүгд өөр өөрийн төгсгөлийн цэгүүдтэй
• API түлхүүр байхгүй — IP хаяг
• CORS — Access-Control-Allow-Origin: * (хэрэглэгчийн талд ашиглах боломжтой)
• Хязгаарлалт: 60 IP- ийн хүсэлт/ цаг (HTTP 429- ийг хэтрүүлбэл)
• Буруунууд нь чөлөөтэй — Зөвхөн амжилттай (2xx) хариулт л сарын квотыг ашиглана. 400, 401, 404, 429, 500- ийн хариултууд үнэгүй.

Үндсэн URL

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

Индекс - бүх тооцоолууруудын жагсаалт

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

Бүх тооцоолууруудын машин уншигдах жагсаалтыг өгөгдлийн талбар (толь, тэмдэгт, төрөл, урьдчилсан, нэгж) болон үр дүнгийн түлхүүртэй нь буцаана. Энэ нь хэрэглэгчийг динамик байдлаар бүтээхэд хангалттай. Бүх талбарууд нь шаардлагатай тэмдэгтэй байдаг. Зарим талбарууд нь стандарт бус (жишээ нь, өдөр) тул үнэн байх ёстой. Үүнийг илгээнэ үү: зарим тооцоологчид нэгийг нь гаргана, бусад нь 400- ийг гаргана.

Тооцоо - нэг тооцоолуурыг ажиллуулна

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

Хариулт хэлбэр:

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

Улсаас хамаарах тооцоолуурууд (хөрөнгийн зээл, зээл, орлогын татвар, борлуулалтын татвар...) хүлээн авдаг ?country=us|uk|ca|au|in|ie|nz|za. Тодорхойгүй бөглөрөл 404- ийг буцаана; дэмжигдээгүй улс эсвэл буруу оруулсан мэдээлэл нь 400- ийг буцаана. Энэ нь туслах мэдээллийг агуулж, талбарын тодорхойлолтыг агуулна.

Параметрүүд, урьдчилсан тохиргоо, алдаа

Зөвхөн анхаарах талбаруудыг илгээх. Хэрэв та юу ч үлдээх юм бол тэр талбарын хэвлэгдсэн хэвийн утгагаар дүүргэнэ - тооцоолуурын хуудасны урьдчилан дүүргэсэн утга, ингэснээр API болон вэб сайтууд ижил оруулалтанд ижил тоог үргэлж өгдөг. Бүх хариултууд нь доор нь юуг дүүргэсэн талаар жагсаалт гаргана. defaults_applied.

API- ийн үнэн зөвөөр шийдэж чадахгүй бүх зүйл нь алдаа, нуль биш: буруу бичсэн параметр, буруу төрлийн утга, үл мэдэгдэх өргөх сонголт, эсвэл алдаатай талбар (өдрийн талбар - төрсөн огноо нь таамаглаж чадахгүй). 400- ийн дараа алдаатай параметрийг нэрлэж, бүх талбарын тодорхойлолтыг эргэн сануулж, үйлчлүүлэгч өөрөө засаж болно.

$ 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/ index нь бүх талбарын түлхүүр, төрөл, нэгж, default болон шаардлагатай эсэхийг нийтэлж өгнө. Энэ нь хэзээ ч таамаглахгүй хэрэглэгчийг бүтээхэд хангалттай.

Ангилал

Та API-г түлхүүргүйгээр дуудах боломжтой - нууц үггүй хүсэлтүүд IP-ээр хязгаарлагддаг. Хэрэв та сарын квотыг (эсвэл бизнесийн зорилгоор ашиглах) нэмэгдүүлэхийг хүсвэл, дансны хуудаснаас түлхүүр үүсгэж, дараах3аргаар илгээнэ үү:

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"

• Хязгааргүй — нууц (IP хурдаар хязгаарлагдсан) эсвэл сар бүр бага хэмжээний үнэтэй үнэгүй түлхүүр. Худалдааны бус.
• Хөгжүүлэгч $9/ сар — 10,000 дуудлага/сар, худалдааны зориулалттай.
• Бизнес $49/сар — 100,000 дуудлага/сар, нэн тэргүүний дамжуулалт.

Таны квотаас юуг хасах вэ

Зөвхөн амжилттай хариулт л энэ үүрэгтэй. Нэг 2xx = нэг дуудлага. Бүх алдаа нь үнэгүй: 400 нь буруу бичсэн параметр, буруу утга эсвэл шаардлагатай талбар алга, 404 нь үл мэдэгдэх слуг, 401 нь буруу түлхүүр, 429, эсвэл бидний талд ямар ч алдаа гарвал. Хэлэлцээрийг шалгаж, хүслээ хэд хэдэн удаа зас. Та хариулт, засварлахын төлөө төлбөр төлдөггүй.

Буруунууд нь үнэгүй тул хурдаар хязгаарлагдсан: нэг товч нь илүү олон алдааг үүсгэдэг бол 200 Хэрэв нэг цагийн дотор хариуг хүлээн аваагүй бол, цаг дуусах хүртэл HTTP 429 "too_many_invalid_requests" гэсэн хариуг хүлээнэ. Сайн дуудлага хэзээ ч энэ тоонд багтахгүй, тиймээс ажиллах нэгдэл хэзээ ч үүнийг харахгүй - энэ нь зөвхөн дахин оролдох циклд ороод байгаа хэрэглэгчийг илрүүлнэ.

Товчны сарын квота дууссан үед API HTTP 429-ийг "quota_exceeded" алдаатай эргүүлэн өгнө; үл мэдэгдэх эсвэл идэвхгүй түлхүүр HTTP 401-ийг эргүүлэн өгнө. Бүх төлөвлөгөөг үзэж, бүртгүүлээрэй Үнэ хуудас.

Жишээ

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

Бүх төгсгөлийн цэг

Нэг тооцоолуурын нэг төгсгөлийн цэг. Бүх талбарын түлхүүрүүд болон үр дүнгийн түлхүүрүүд нь /api/v1/ индекс.