WaterMeter AI
HizkuntzaEuskara
Beste hizkuntzak

Ur-neurgailua OCR API

Ur-neurgailua OCR API. Orri honek webgunearen atzealdeak hirugarrenen integrazioetarako HTTP API publikoa dokumentatzen du.

Hasi benetako igoera batekin

Lehenik eta behin erregistratu, zure ur neurgailuaren argazkia igo lan-espazioan, eta gero API giltza bat sortu integratzeko prest zaudenean.

Izena eman eta argazki bat igoSortu API Gako bat

Laburpena

  • Erabili webgunearen atzeko aldea kanpoko integrazio guztietarako.
  • Ez deitu waterMeterAi zuzenean hirugarren alderdiko programetatik.
  • API irekiak web atariaren erabiltzaile, kuota, cache, zeregin eta auditoretza arau berak partekatzen ditu.
  • Backend-ak beheranzko AI zerbitzu desberdinak erabil ditzake deployment konfigurazioaren arabera.
  • Zereginen erantzunek result_summary objektu generikoa dute, zerbitzu desberdinek emaitza mota desberdinak erakutsi ahal izateko.

Autentifikazioa

  • Sartu saioa webgunean eta sortu API giltza API Keys orrian.
  • Gako API osoa behin bakarrik erakusten da sortzen denean.
  • Bidali giltza Authorization goiburuan eskaera bakoitzean.
Authorization: Bearer wm_xxxxxxxxxxxxxxxxx

API Key Permissions and Limits

  • Each API key can have independent scopes, an IPv4/IPv6/CIDR allowlist, a total requests-per-minute limit, and a task submissions-per-minute limit.
  • A valid key without the required scope or outside its source IP allowlist returns 403.
  • Every valid-key request consumes the total request limit, including requests rejected by scope, IP, or submission policy.
  • Batch requests consume one total request unit and one submission unit per uploaded file.
  • Rate-limited responses return 429 with Retry-After and both X-RateLimit-* and X-SubmissionLimit-* headers.
  • Task creation also has a per-key concurrency limit and returns X-ConcurrencyLimit-* headers; a concurrency rejection uses 429.
  • For batch concurrency, only files that pass image validation reserve slots, and success headers report the actual active slots after task binding.
Retry-After: 30
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1785902400
X-SubmissionLimit-Limit: 10
X-SubmissionLimit-Remaining: 9
X-ConcurrencyLimit-Limit: 3
X-ConcurrencyLimit-Active: 1
X-ConcurrencyLimit-Remaining: 2

Igoera Arauak

  • Fitxategi tamaina maximoa: 20MB irudi bakoitzeko.
  • Onartutako formatuak: JPEG, PNG, WEBP.
  • Atzeko aldeak fitxategiaren edukia balioztatzen du, ez soilik fitxategi luzapena.

Igoera Tamainaren Betearazpena

  • Batch igoerek lehenetsita 8 irudi arte onartzen dituzte, 20MB irudi bakoitzeko muga eta 20MB fitxategi edukiaren mugarekin.
  • Bere muga gainditzen duen fitxategi edo multzo batek 413 itzultzen du irudiaren balidazioa edo zeregina sortu aurretik; Ez da partzialki sortzen.
  • Backend-ak jasotako byte kopuru benetakoa betetzen du Content-Length falta denean edo chunked transfer erabiltzen denean ere.

Zereginen egoerak

  • queued: Onartuta eta AIaren prozesamenduaren zain.
  • running: Une honetan prozesatzen ari da, edo dispatcher-ari eman zaio eta azken emaitza lortzeko egoera aldizka egiaztatzen ari da.
  • batch_waiting_ai: Multzoko elementu guztiak AI zerbitzua berriro online egoteko zain daude.
  • batch_running: Multzoa dispatcher-ari eman zaio eta oraindik prozesatzen ari da.
  • done: Behar bezala amaitu da.
  • failed: Prozesamenduak huts egin du.
  • waiting_ai: AI zerbitzua berriro online egon arte ilaran geratzen da, eta ondoren automatikoki jarraitzen du.

Emaitza Iturriak

  • fresh: AI prozesamendu berri batek sortua.
  • cached_exact: Uneko AI bertsioaren cachearekin bat dator.
  • cached_stale: AI offline dago eta cacheko azken emaitza itzuli da.
  • pending: Oraindik ez dago azken emaitzarik.
  • failed: Zereginak huts egin du.
  • Zeregin bat oraindik amaitu ez denean, begiratu error_message azken saiakera edo itxaroteko arrazoia.

Kuota eta Fakturazioa

  • Erabili `GET /api/open/quota` lan-karga handiak bidali aurretik, zure integrazioak kuota huts egitea saihestu behar badu.
  • AI prozesamendu `fresh` berriek soilik kontsumitzen dute kuota.
  • `cached_exact`, `cached_stale`, `pending`eta `failed` emaitzek ez dute kuota kontsumitzen.
  • Doako kontuek eguneroko kuota erabiltzen dute lehenik. Ordaindutako kontuek kuota periodiko aktiboak erabiltzen dituzte, eta gero kuota aldi baterako edo finkoak atzeko politikaren arabera.
  • Kuota agortzen denean, zereginaren bidalketak `429` itzultzen du eta errore mezu bat sartzen du, zeregin berri bat sortu beharrean.

Cachea eta Emaitzen Freskotasuna

  • Backend-ak emaitza arrakastatsuak cachean gordetzen ditu irudiaren hash-aren eta AI bertsioaren arabera, beheranzko zerbitzuaren namespace barne.
  • `cached_exact` balioak esan nahi du irudi berak dagoeneko emaitza arrakastatsua duela uneko AI bertsioan; beraz, ez zen AI prozesamendu berririk behar.
  • `cached_stale` esan nahi du AI zerbitzua lineaz kanpo dagoela eta atzealdeak azken emaitza historikoa itzuli duela.
  • `is_latest_ai_version` false denean, gorde emaitza datu historiko erabilgarri baina berrikusi beharreko gisa.
  • Ez suposatu zeregin `done` guztiak kontsumitzen dituzten kuotak; Begiratu `result_source`.

Task completion webhooks

  • Send signed task completion events to your HTTPS endpoint with automatic retries.
  • This API key is inactive. Existing records remain available, but new, enabled, test, and secret-rotation operations are blocked.
X-WaterMeter-Webhook-Id: whev_new_event
X-WaterMeter-Webhook-Replay-Of: whev_original_event
replay_of_event_id: whev_original_event
blocked endpoint management: HTTP 409
canceled delivery status: canceled

GET/api/open/quota

Irakurri egungo kuota eta geratzen den erabilera.

Eskaera adibidea
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Erantzun adibidea
{
  "ok": true,
  "email": "[email protected]",
  "quota": {
    "account_type": "free",
    "daily_limit": 20,
    "used": 3,
    "remaining": 17,
    "day_tag": "2026-06-01",
    "is_unlimited": false,
    "monthly_remaining": 0,
    "monthly_bonus_remaining": 0,
    "fixed_remaining": 0,
    "nearest_expire_at": null,
    "quota_summary_text": "Free daily quota: 3/20 used today. Remaining: 17."
  }
}

GET/api/open/ai-status

Irakurri zerbitzu publikoaren egoera zereginak bidaltzeko eta zerbitzua erabilgarri ez dagoenean cacheko emaitzetara jotzeko.

Eskaera adibidea
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Erantzun adibidea
{
  "ok": true,
  "is_online": true,
  "busy": false,
  "active_jobs": 0,
  "public_status": "online",
  "public_status_label": "online",
  "public_status_reason": "ready",
  "accepts_new_tasks": true,
  "can_return_cached_result": true,
  "queue_state": "idle",
  "queue_count": 0,
  "current_ai_version": "water_v2:wm-ai-v2-2026-06-01",
  "last_checked_at": "2026-06-01T06:15:30Z"
}

POST/api/open/tasks

Irudi bat igo eta zeregin bakarra sortu.

Eskaera adibidea
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Erantzun adibidea
{
  "ok": true,
  "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
  "status": "queued",
  "result_source": "pending",
  "visibility": "private",
  "ai_online": true,
  "is_latest_ai_version": false,
  "final_reading": "-",
  "result_summary": {
    "resultKind": "unknown",
    "primaryLabel": "Result",
    "primaryValue": "-",
    "secondaryLabel": "Detail",
    "secondaryValue": "-",
    "summaryText": "No result is available yet."
  },
  "error_message": "",
  "created_at": "2026-06-01T06:16:10Z"
}

GET/api/open/tasks/{task_id}

Irakurri zeregin baten egoera eta azken irakurketa.

Eskaera adibidea
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Erantzun adibidea
{
  "ok": true,
  "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
  "status": "done",
  "result_source": "fresh",
  "ai_online": true,
  "is_latest_ai_version": true,
  "final_reading": "123.45",
  "meter_type": "pointer",
  "success": "yes",
  "result_summary": {
    "resultKind": "water_meter",
    "primaryLabel": "Final Reading",
    "primaryValue": "123.45",
    "secondaryLabel": "Meter Type",
    "secondaryValue": "pointer",
    "summaryText": "Water meter recognition finished."
  },
  "error_message": "",
  "created_at": "2026-06-01T06:16:10Z"
}

GET/api/open/tasks

Irakurri uneko API gakoaren erabiltzailearen azken zereginak.

Eskaera adibidea
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Erantzun adibidea
{
  "ok": true,
  "items": [
    {
      "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
      "status": "done",
      "result_source": "cached_exact",
      "final_reading": "123.45",
      "meter_type": "pointer",
      "success": "yes",
      "result_summary": {},
      "ai_online": true,
      "is_latest_ai_version": true,
      "created_at": "2026-06-01T06:16:10Z",
      "error_message": ""
    }
  ]
}

POST/api/open/batches

Irudi anitz igo eskaera bakarrean.

Eskaera adibidea
curl -X POST "https://watermeterai.com/api/open/batches" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "files=@D:\data\meter_001.jpg" \
  -F "files=@D:\data\meter_002.jpg"
Erantzun adibidea
{
  "ok": true,
  "batch_id": "5a14f4e5f6d34fdabce00e62c0dd0001",
  "status": "batch_running",
  "total_count": 2,
  "done_count": 0,
  "failed_count": 0,
  "pending_count": 2,
  "items": [
    {
      "index": 0,
      "file_name": "meter_001.jpg",
      "task_id": "task_a",
      "status": "queued",
      "result_source": "pending",
      "final_reading": "-",
      "failure_kind": "",
      "error_message": ""
    },
    {
      "index": 1,
      "file_name": "meter_002.jpg",
      "task_id": "task_b",
      "status": "queued",
      "result_source": "pending",
      "final_reading": "-",
      "failure_kind": "",
      "error_message": ""
    }
  ]
}

GET/api/open/batches/{batch_id}

Irakurri batch aurrerapena eta fitxategi bakoitzeko zeregin egoerak.

Eskaera adibidea
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Erantzun adibidea
{
  "ok": true,
  "batch_id": "5a14f4e5f6d34fdabce00e62c0dd0001",
  "status": "batch_done",
  "total_count": 2,
  "done_count": 2,
  "failed_count": 0,
  "pending_count": 0,
  "items": [
    {
      "index": 0,
      "file_name": "meter_001.jpg",
      "task_id": "task_a",
      "status": "done",
      "result_source": "fresh",
      "final_reading": "123.45",
      "failure_kind": "",
      "error_message": ""
    },
    {
      "index": 1,
      "file_name": "meter_002.jpg",
      "task_id": "task_b",
      "status": "done",
      "result_source": "cached_exact",
      "final_reading": "456.78",
      "failure_kind": "",
      "error_message": ""
    }
  ]
}

Gomendatutako Fluxua

  • Egiaztatu `GET /api/open/ai-status` lan karga handiak bidali aurretik.
  • Gorde `task_id` edo `batch_id` zure sisteman bidali ondoren berehala.
  • Hartu `queued`, `running`, `waiting_ai`, `batch_waiting_ai` eta `batch_running` amaitu gabeko egoeratzat, eta jarraitu egoera aldizka egiaztatzen.
  • Erabili batch eskaerak backend-erako sareak latentzia handia duenean eta instalatutako zerbitzuak batch modua onartzen duenean.
  • Batch eskaerak gaur egun `webBackend -> dispatchCenter -> waterMeterAi`bidez pasatzen dira.
  • `batch_waiting_ai` esan nahi du elementu guztiak oraindik AI zerbitzuaren zain daudela, oraindik ez daudela martxan.
  • Instalatutako zerbitzua `CAD` denean, erabili oraingoz `POST /api/open/tasks` eta hartu batch igoera erabilgarri ez dagoela.

Errore Oharrak

  • 400: eskaera baliogabea da, edo instalatutako zerbitzuak ez du batch igoera onartzen.
  • 401: API gakoa falta da, baliogabea da, iraungita dago edo desgaituta dago.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: zeregina edo lotea aurkitu gabe, edo erabiltzailearen jabetzakoa ez dena.
  • 413: fitxategia handiegia.
  • 415: irudi mota onartu gabea edo irudi edukia baliogabea.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
400 batch igoera ez eskuragarri
{
  "detail": "batch upload is not supported for business: cax"
}
401 falta edo baliogabea API giltza
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
413 fitxategia handiegia da
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
429 kuota agortu da
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Prest zaude lan-fluxua probatzeko?

Lehen argazkirako web lan-espazioa erabili, eta gero API gakoetara pasa emaitza zure sistemara egokitzen denean.

Izena eman eta argazki bat igoSortu API Gako bat