Skip to content

Обзор HTTP API

Эндпоинт зашит в SDK на этапе сборки (переменная OPTIMATICA_API_URL). Production по умолчанию:

https://meters-api-prod.nyc-1.optimatica.pro/api/meters/analyze

Эндпоинты

МетодПутьОписание
POST/api/meters/analyzeРаспознавание счётчика по фото

Аутентификация

http
Authorization: Bearer ВАШ_JWT

Формат запросов

  • Content-Type: multipart/form-data
  • Поле файла: image (JPEG/PNG, до 20 MB)

Формат ответов

Все ответы — JSON. При успешном HTTP 200 тело может быть:

  • { success: true, meter: { ... } } — счётчик распознан
  • { success: false, error: "..." } — фото не распознано (не HTTP-ошибка)

Ошибки авторизации и квоты — HTTP 4xx с { error: string }.

Документация и playground

РазделОписание
Справочник APIПолная спецификация REST API (cURL, fetch, Python)
API PlaygroundИнтерактивная отправка запроса без SDK
Vue SDK PlaygroundLive-превью MeterPhotoAnalyzer (Vue)
React SDK PlaygroundLive-превью MeterPhotoAnalyzer (React)

SDK

HTTP-вызовы инкапсулированы в optimatica-meters:

ts
import { analyzeMeterPhoto } from 'optimatica-meters'
const result = await analyzeMeterPhoto(file, { apiKey: 'eyJhbGci...' })

См. POST /api/meters/analyze для краткого описания эндпоинта и справочник для полной спецификации.

MIT License