WaterMeter AI
JęzykPolski
Inne języki

API OCR wodomierzy

API OCR wodomierzy. Ta strona dokumentuje publiczne HTTP API ujawnione przez zaplecze witryny w celu integracji z firmami zewnętrznymi.

Zacznij od prawdziwego przesłania

Najpierw zarejestruj konto, prześlij własne zdjęcie wodomierza w workspace, a potem utwórz klucz API, gdy będziesz gotowy do integracji.

Zarejestruj się i prześlij zdjęcieUtwórz klucz API

Przegląd

  • Wykorzystaj backend serwisu do wszelkich integracji zewnętrznych.
  • Nie dzwoń do waterMeterAi bezpośrednio z programów innych firm.
  • Otwarty API ma tych samych użytkowników, przydziały, pamięć podręczną, zadania i reguły inspekcji co portal internetowy.
  • Backend może być ukierunkowany na różne firmy niższego szczebla AI według konfiguracji wdrożenia.
  • Odpowiedzi na zadania zawierają teraz ogólny obiekt result_summary, dzięki czemu różne firmy mogą wyświetlać różne typy wyników.

Uwierzytelnianie

  • Zaloguj się na stronie i utwórz klucz API na stronie API Klucze.
  • Pełny klucz API jest wyświetlany tylko raz podczas jego tworzenia.
  • Wysyłaj klucz w nagłówku Autoryzacji przy każdym żądaniu.
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

Prześlij zasady

  • Maksymalny rozmiar pliku: 20MB na obraz.
  • Obsługiwane formaty: JPEG, PNG, WEBP.
  • Backend sprawdza rzeczywistą zawartość pliku, a nie tylko rozszerzenie pliku.

Egzekwowanie rozmiaru przesyłania

  • Przesyłanie zbiorcze domyślnie akceptuje maksymalnie 8 obrazów, z limitem 20 MB na obraz i 20 MB całkowitego limitu zawartości pliku.
  • Plik lub partia, która przekracza swój limit, zwraca 413 przed sprawdzeniem obrazu lub utworzeniem zadania; nie jest tworzona żadna częściowa partia.
  • Backend wymusza faktyczną liczbę odebranych bajtów, nawet jeśli brakuje Content-Length lub używany jest transfer fragmentaryczny.

Stany zadań

  • queued: zaakceptowane i oczekujące na przetworzenie AI.
  • running: aktualnie przetwarzany lub już przekazany dyspozytorowi i nadal odpytujący o wynik końcowy.
  • batch_waiting_ai: każdy element w partii oczekuje na powrót usługi AI do trybu online.
  • batch_running: partia została już przekazana dyspozytorowi i jest w trakcie realizacji.
  • done: zakończone pomyślnie.
  • failed: przetwarzanie failed.
  • waiting_ai: queued do czasu, aż usługa AI powróci do trybu online, następnie zostanie wznowiona automatycznie.

Źródła wyników

  • fresh: wygenerowany przez nowe uruchomienie AI.
  • cached_exact: pasuje do bieżącej pamięci podręcznej wersji AI.
  • cached_stale: AI offline, zwrócono najnowszy wynik z pamięci podręcznej.
  • pending: nie ma jeszcze ostatecznego wyniku.
  • failed: zadanie failed.
  • Jeśli zadanie nie jest jeszcze done, sprawdź error_message, aby dowiedzieć się, czy nie nastąpiła ostatnia ponowna próba lub powód oczekiwania.

Limity i rozliczenia

  • Użyj `GET /api/open/quota` przed wysłaniem dużych zadań, jeśli integracja ma unikać błędów limitu.
  • Tylko uruchomienia AI `fresh` zużywają limit.
  • Wyniki `cached_exact`, `cached_stale`, `pending` i `failed` nie zużywają limitu.
  • Konta darmowe najpierw używają limitu dziennego. Konta płatne używają aktywnych okresowych pakietów limitu, a następnie limitu tymczasowego lub stałego zgodnie z polityką backendu.
  • Po wyczerpaniu limitu wysłanie zadania zwraca `429` i komunikat błędu zamiast tworzyć nowe zadanie.

Cache i aktualność wyniku

  • Backend buforuje udane wyniki według hasha obrazu i wersji AI, w tym namespace biznesu downstream.
  • `cached_exact` oznacza, że ten sam obraz ma już udany wynik dla bieżącej wersji AI, więc nowe uruchomienie AI nie było potrzebne.
  • `cached_stale` oznacza, że usługa AI jest offline, a backend zwrócił najnowszy dostępny wynik historyczny.
  • Gdy `is_latest_ai_version` ma wartość false, przechowuj wynik jako użyteczne, ale wymagające weryfikacji dane historyczne.
  • Nie zakładaj, że każde zadanie `done` zużyło limit; sprawdź `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

Przeczytaj aktualny limit i pozostałe wykorzystanie.

Poproś o przykład
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Przykład odpowiedzi
{
  "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

Przeczytaj status usługi publicznej dotyczący przesyłania zadań i zastępczego przywracania wyników w pamięci podręcznej.

Poproś o przykład
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Przykład odpowiedzi
{
  "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

Prześlij jeden obraz i utwórz jedno zadanie.

Poproś o przykład
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Przykład odpowiedzi
{
  "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}

Przeczytaj status jednego zadania i odczyt końcowy.

Poproś o przykład
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Przykład odpowiedzi
{
  "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

Przeczytaj ostatnie zadania należące do bieżącego kluczowego użytkownika API.

Poproś o przykład
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Przykład odpowiedzi
{
  "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

Prześlij wiele obrazów w jednym żądaniu.

Poproś o przykład
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"
Przykład odpowiedzi
{
  "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}

Odczytuj postęp wsadowy i stany zadań poszczególnych plików.

Poproś o przykład
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Przykład odpowiedzi
{
  "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": ""
    }
  ]
}

Zalecany przepływ

  • Sprawdź `GET /api/open/ai-status` przed wysłaniem dużych obciążeń.
  • Zapisz `task_id` lub `batch_id` w swoim własnym systemie natychmiast po przesłaniu.
  • Traktuj `queued`, `running`, `waiting_ai`, `batch_waiting_ai` i `batch_running` jako stany inne niż końcowe i kontynuuj odpytywanie.
  • Użyj żądań wsadowych, gdy ścieżka sieciowa do zaplecza ma duże opóźnienia, a wdrożona firma obsługuje tryb wsadowy.
  • Żądania wsadowe przepływają obecnie przez `webBackend -> dispatchCenter -> waterMeterAi`.
  • `batch_waiting_ai` oznacza, że ​​każdy przedmiot nadal oczekuje na usługę AI, ale jeszcze nie aktywnie running.
  • Jeśli wdrożona firma to `CAD`, użyj na razie `POST /api/open/tasks` i traktuj przesyłanie wsadowe jako niedostępne.

Notatki o błędach

  • 400: nieprawidłowe żądanie lub wdrożona firma nie obsługuje przesyłania wsadowego.
  • 401: brakujący, nieprawidłowy, wygasły lub wyłączony klucz API.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: Nie odnaleziono zadania lub partii albo nie są one własnością bieżącego użytkownika.
  • 413: plik jest za duży.
  • 415: nieobsługiwany typ obrazu lub nieprawidłowa treść obrazu.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
Przesyłanie wsadowe 400 jest niedostępne
{
  "detail": "batch upload is not supported for business: cax"
}
401 brakujący lub nieprawidłowy klucz API
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
Plik 413 jest za duży
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
Limit 429 wyczerpany
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Gotowy przetestować workflow?

Użyj web workspace dla pierwszego zdjęcia, a potem przejdź do kluczy API, gdy format wyniku pasuje do systemu.

Zarejestruj się i prześlij zdjęcieUtwórz klucz API