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

// ── Запрос: загрузка через FormData ──
const form = new FormData();
form.append("image", imageInput.files[0]);
form.append("template", templateInput.files[0]);
form.append("method", "TM_CCOEFF_NORMED");
form.append("threshold", "0.8");

const res = await fetch("/api/v1/match/template", {
  method: "POST",
  body: form,
});
const task = await res.json();

// ── Ответ task: ──
// {uid: "d83ae21c-...", status: "queued", tool: "template",
//  params: {method:"TM_CCOEFF_NORMED", threshold:0.8, max_results:20, use_grayscale:true},
//  input_files: ["uploads/d83ae.../screenshot.png","uploads/d83ae.../icon.png"]}

// ── Запрос: поллинг статуса до завершения ──
async function waitForResult(uid) {
  while (true) {
    const r = await fetch(`/api/v1/tasks/${uid}`);
    const data = await r.json();
    if (data.status === "done" || data.status === "error")
      return data;
    await new Promise(r => setTimeout(r, 1000));
  }
}
const result = await waitForResult(task.uid);

// ── Ответ result (когда done): ──
// {uid: "d83ae21c-...", status: "done",
//  result_files: ["results/d83ae.../matches.png","results/d83ae.../heatmap.png"],
//  result_data: {method:"TM_CCOEFF_NORMED", matches_found:3, best_score:0.97,
//    matches: [{x:120,y:45,w:32,h:32,score:0.97}, ...]}}

import requests
import time

# ── Запрос: отправить изображения ──
files = {
    "image": open("screenshot.png", "rb"),
    "template": open("icon.png", "rb"),
}
data = {
    "method": "TM_CCOEFF_NORMED",
    "threshold": "0.8",
    "max_results": "20",
}
resp = requests.post(
    "http://localhost:8888/api/v1/match/template",
    files=files, data=data,
)
task = resp.json()

# ── Ответ task: ──
# {"uid": "d83ae21c-...", "status": "queued", "tool": "template",
#  "params": {"method":"TM_CCOEFF_NORMED", "threshold":0.8,
#             "max_results":20, "use_grayscale":true},
#  "input_files": ["uploads/d83ae.../screenshot.png", "uploads/d83ae.../icon.png"]}

# ── Запрос: дождаться результата ──
while True:
    r = requests.get(f"http://localhost:8888/api/v1/tasks/{task['uid']}")
    status = r.json()
    if status["status"] in ("done", "error"):
        break
    time.sleep(1)

# ── Ответ status (когда done): ──
# {"uid": "d83ae21c-...", "status": "done",
#  "result_files": ["results/d83ae.../matches.png", "results/d83ae.../heatmap.png"],
#  "result_data": {"method": "TM_CCOEFF_NORMED", "matches_found": 3, "best_score": 0.97,
#    "matches": [{"x":120,"y":45,"w":32,"h":32,"score":0.97}, ...]}}

// ── Запрос: загрузка через FormData ──
const form = new FormData();
form.append("query_image", fileInput1.files[0]);
form.append("train_image", fileInput2.files[0]);
form.append("detector", "SIFT");
form.append("ratio_threshold", "0.75");

const res = await fetch("/api/v1/match/feature", {
  method: "POST",
  body: form,
});
const task = await res.json();

// ── Ответ task: ──
// {uid: "f47ac10b-...", status: "queued", tool: "feature",
//  params: {detector:"SIFT", matcher:"FLANN", ratio_threshold:0.75, max_matches:200},
//  input_files: ["uploads/f47ac.../photo1.jpg","uploads/f47ac.../photo2.jpg"],
//  result_files: [], result_data: {}}

// ── Запрос: поллинг статуса до завершения ──
async function waitForResult(uid) {
  while (true) {
    const r = await fetch(`/api/v1/tasks/${uid}`);
    const data = await r.json();
    if (data.status === "done" || data.status === "error")
      return data;
    await new Promise(r => setTimeout(r, 1000));
  }
}
const result = await waitForResult(task.uid);

// ── Ответ result (когда done): ──
// {uid: "f47ac10b-...", status: "done",
//  result_files: ["results/f47ac.../matches.png"],
//  result_data: {query_keypoints:1523, train_keypoints:1847,
//    good_matches:342, detector:"SIFT", matcher:"FLANN"}}

import requests
import time

# ── Запрос: отправить изображения ──
files = {
    "query_image": open("photo1.jpg", "rb"),
    "train_image": open("photo2.jpg", "rb"),
}
data = {
    "detector": "SIFT",
    "matcher": "FLANN",
    "ratio_threshold": "0.75",
    "max_matches": "200",
}
resp = requests.post(
    "http://localhost:8888/api/v1/match/feature",
    files=files, data=data,
)
task = resp.json()

# ── Ответ task: ──
# {"uid": "f47ac10b-...", "status": "queued", "tool": "feature",
#  "params": {"detector":"SIFT", "matcher":"FLANN",
#             "ratio_threshold":0.75, "max_matches":200},
#  "input_files": ["uploads/f47ac.../photo1.jpg", "uploads/f47ac.../photo2.jpg"],
#  "result_files": [], "result_data": {}}

# ── Запрос: дождаться результата ──
while True:
    r = requests.get(f"http://localhost:8888/api/v1/tasks/{task['uid']}")
    status = r.json()
    if status["status"] in ("done", "error"):
        break
    time.sleep(1)

# ── Ответ status (когда done): ──
# {"uid": "f47ac10b-...", "status": "done",
#  "result_files": ["results/f47ac.../matches.png"],
#  "result_data": {"query_keypoints": 1523, "train_keypoints": 1847,
#    "good_matches": 342, "detector": "SIFT", "matcher": "FLANN"}}

// ── Запрос: отправка PLY файлов ──
const form = new FormData();
form.append("model_file", modelInput.files[0]);
form.append("scene_file", sceneInput.files[0]);
form.append("relative_sampling_step", "0.025");
form.append("use_icp", "true");

const res = await fetch("/api/v1/match/surface", {
  method: "POST",
  body: form,
});
const task = await res.json();

// ── Ответ task: ──
// {uid: "b82f4c...", status: "queued", tool: "surface",
//  params: {relative_sampling_step:0.025, use_icp:true, icp_iterations:100, ...},
//  input_files: ["uploads/b82f4c.../model.ply","uploads/b82f4c.../scene.ply"]}

// ── Поллинг и ответ: ──
const r = await fetch(`/api/v1/tasks/${task.uid}`);
const result = await r.json();
// {uid: "b82f4c...", status: "done",
//  result_data: {pose: [[0.99,-0.01,0.03,12.5],...],
//    num_model_points:4521, num_scene_points:18230, icp_residual:0.0023}}

import requests, time

# ── Запрос: отправить PLY файлы ──
files = {
    "model_file": open("model.ply", "rb"),
    "scene_file": open("scene.ply", "rb"),
}
data = {
    "relative_sampling_step": "0.025",
    "use_icp": "true",
    "icp_iterations": "200",
}
resp = requests.post(
    "http://localhost:8888/api/v1/match/surface",
    files=files, data=data,
)
task = resp.json()

# ── Ответ task: ──
# {"uid": "b82f4c...", "status": "queued", "tool": "surface",
#  "params": {"relative_sampling_step":0.025, "use_icp":true, "icp_iterations":200, ...},
#  "input_files": ["uploads/b82f4c.../model.ply","uploads/b82f4c.../scene.ply"]}

# ── Запрос: дождаться результата ──
while True:
    r = requests.get(f"http://localhost:8888/api/v1/tasks/{task['uid']}")
    result = r.json()
    if result["status"] in ("done", "error"):
        break
    time.sleep(1)

# ── Ответ result (когда done): ──
# {"uid": "b82f4c...", "status": "done",
#  "result_data": {
#    "pose": [[0.99,-0.01,0.03,12.5],[0.01,0.99,-0.02,-3.1],
#             [-0.03,0.02,0.99,0.8],[0.0,0.0,0.0,1.0]],
#    "num_model_points": 4521, "num_scene_points": 18230,
#    "icp_residual": 0.0023}}

const form = new FormData();
form.append('image', imageFile);
form.append('template', templateFile);
form.append('steps', JSON.stringify([
  {tool: 'template', params: {method: 'TM_CCOEFF_NORMED', threshold: 0.95}},
  {tool: 'template', params: {threshold: 0.7}},
  {tool: 'feature',  params: {detector: 'SIFT', ratio_threshold: 0.7}},
]));

const res = await fetch('http://localhost:8888/api/v1/match/chain', {
  method: 'POST',
  body: form,
});
const data = await res.json();

// ── Ответ: ──
// {uid: 'abc123', status: 'queued', tool: 'chain', ...}

import requests, json

steps = [
    {"tool": "template", "params": {"method": "TM_CCOEFF_NORMED", "threshold": 0.95}},
    {"tool": "template", "params": {"threshold": 0.7}},
    {"tool": "feature",  "params": {"detector": "SIFT", "ratio_threshold": 0.7}},
]

resp = requests.post(
    "http://localhost:8888/api/v1/match/chain",
    files={
        "image": open("photo.png", "rb"),
        "template": open("icon.png", "rb"),
    },
    data={"steps": json.dumps(steps)},
)
print(resp.json())

# ── Ответ: ──
# {"uid": "abc123", "status": "queued", "tool": "chain", ...}

import requests

# ── Запрос: ──
resp = requests.get(
    "http://localhost:8888/api/v1/tasks",
    params={"offset": 0, "limit": 20},
)
data = resp.json()

# ── Ответ data: ──
# {"total": 42, "tasks": [
#   {"uid": "f47ac10b-...", "status": "done", "tool": "feature",
#    "created_at": "2024-01-15T10:30:00", "updated_at": "2024-01-15T10:30:12",
#    "input_files": [...], "result_files": [...], "result_data": {...}},
#   ...]}

print(f"Всего задач: {data['total']}")
for t in data["tasks"]:
    print(f"  {t['uid'][:12]}  {t['status']:12s}  {t['tool']}")

import requests

# ── Запрос: ──
uid = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
resp = requests.get(f"http://localhost:8888/api/v1/tasks/{uid}")

if resp.status_code == 404:
    print("Задача не найдена")
    # Ответ: {"detail": "Task not found"}
else:
    task = resp.json()
    # ── Ответ task: ──
    # {"uid": "a1b2c3d4-...", "status": "done", "tool": "feature",
    #  "result_files": ["results/a1b2c3d4.../matches.png"],
    #  "result_data": {"query_keypoints":1523, ...}, "error": null}
    print(f"Статус: {task['status']}")
    if task["status"] == "done":
        print(f"Файлы результатов: {task['result_files']}")
    elif task["status"] == "error":
        print(f"Ошибка: {task['error']}")

import requests

# ── Запрос: получить настройки Template Matching ──
tmpl = requests.get(
    "http://localhost:8888/api/v1/settings/template"
).json()

# ── Ответ tmpl: ──
# {"tool": "template", "params": {
#   "method": "TM_CCOEFF_NORMED", "threshold": 0.8,
#   "max_results": 20, "use_grayscale": true}}

# ── Запрос: обновить настройки Template Matching ──
resp = requests.put(
    "http://localhost:8888/api/v1/settings/template",
    json={
        "method": "TM_CCOEFF_NORMED",
        "threshold": 0.9,
        "max_results": 10,
        "use_grayscale": True,
    },
)

# ── Ответ: ──
# {"tool": "template", "params": {
#   "method": "TM_CCOEFF_NORMED", "threshold": 0.9,
#   "max_results": 10, "use_grayscale": true}}

# ── Запрос: получить текущие настройки Feature Matching ──
current = requests.get(
    "http://localhost:8888/api/v1/settings/feature"
).json()

# ── Ответ current: ──
# {"tool": "feature", "params": {
#   "detector": "SIFT", "matcher": "FLANN",
#   "ratio_threshold": 0.75, "max_matches": 200}}

# ── Запрос: обновить ──
resp = requests.put(
    "http://localhost:8888/api/v1/settings/feature",
    json={
        "detector": "ORB",
        "matcher": "BFMatcher",
        "ratio_threshold": 0.8,
        "max_matches": 500,
    },
)

# ── Ответ: ──
# {"tool": "feature", "params": {
#   "detector": "ORB", "matcher": "BFMatcher",
#   "ratio_threshold": 0.8, "max_matches": 500}}

const crypto = require("crypto");

function verifySignature(body, secret, signature) {
  const expected = "sha256=" +
    crypto.createHmac("sha256", secret)
      .update(body)
      .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signature),
  );
}

// Express handler
app.post("/callback", (req, res) => {
  const sig = req.headers["x-webhook-signature"];
  if (!verifySignature(JSON.stringify(req.body), "my-secret", sig)) {
    return res.status(401).send("Invalid signature");
  }
  console.log("Task", req.body.uid, req.body.status);
  res.sendStatus(200);
});

import requests

BASE = "http://localhost:8888"

# ── 1. Запрос: зарегистрировать вебхук ──
wh = requests.post(f"{BASE}/api/v1/webhooks", json={
    "url": "https://your-server.com/callback",
    "secret": "my-secret-key",  # опционально
}).json()

# ── Ответ wh: ──
# {"id": "wh_abc123", "url": "https://your-server.com/callback",
#  "created_at": "2024-01-15T10:30:00"}

# ── 2. Запрос: отправить задачу ──
task = requests.post(f"{BASE}/api/v1/match/feature", files={
    "query_image": open("photo1.jpg", "rb"),
    "train_image": open("photo2.jpg", "rb"),
}).json()

# ── Ответ task: ──
# {"uid": "f47ac10b-...", "status": "queued", "tool": "feature", ...}
# Результат придёт POST-запросом на вебхук — поллинг не нужен!

# ── 3. Запрос: посмотреть все вебхуки ──
hooks = requests.get(f"{BASE}/api/v1/webhooks").json()

# ── Ответ hooks: ──
# [{"id": "wh_abc123", "url": "https://your-server.com/callback",
#   "created_at": "2024-01-15T10:30:00"}]

for h in hooks:
    print(f"  {h['id']}  →  {h['url']}")

# ── 4. Запрос: удалить вебхук ──
requests.delete(f"{BASE}/api/v1/webhooks/{wh['id']}")
# Ответ: HTTP 204 No Content

const BASE = "http://localhost:8888";

// ── 1. Запрос: зарегистрировать вебхук ──
const whRes = await fetch(`${BASE}/api/v1/webhooks`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    url: "https://your-server.com/callback",
    secret: "my-secret-key",
  }),
});
const wh = await whRes.json();

// ── Ответ wh: ──
// {id: "wh_abc123", url: "https://your-server.com/callback",
//  created_at: "2024-01-15T10:30:00"}

// ── 2. Запрос: отправить задачу ──
const form = new FormData();
form.append("query_image", fileInput1.files[0]);
form.append("train_image", fileInput2.files[0]);
const taskRes = await fetch(`${BASE}/api/v1/match/feature`, {
  method: "POST", body: form,
});
const task = await taskRes.json();

// ── Ответ task: ──
// {uid: "f47ac10b-...", status: "queued", tool: "feature", ...}

// ── 3. Запрос: список вебхуков ──
const hooks = await (await fetch(`${BASE}/api/v1/webhooks`)).json();

// ── Ответ hooks: ──
// [{id: "wh_abc123", url: "https://your-server.com/callback",
//   created_at: "2024-01-15T10:30:00"}]

hooks.forEach(h => console.log(h.id, "→", h.url));

// ── 4. Запрос: удалить ──
await fetch(`${BASE}/api/v1/webhooks/${wh.id}`, { method: "DELETE" });
// Ответ: HTTP 204 No Content