API анықтамалығы

Аутентификацияланған пайдаланушының профилін қайтарады.

Көрсетілетін атау мен хабарландыру баптаулары сияқты профиль өрістерін жаңартады.

Supabase auth пайдаланушысын платформа пайдаланушысының жазбасымен синхрондайды.

Аутентификацияланған пайдаланушының тіркелуді аяқтағанын хабарлайды.

Аутентификацияланған пайдаланушы үшін жаңа аватар суретін жүктейді.

Аутентификацияланған клиент тіркеген роботтарды, ең жаңасынан бастап, 50 жазбаға дейін тізеді. Уақыт белгілері ISO 8601 форматында; робот бір рет қосылмайынша last_online мен last_heartbeat null болады.

curl https://www.ay-robots.com/api/client/robots \
  -H 'Authorization: Bearer ayr_live_your_key_here'

[
  {
    "id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
    "name": "Lab SO-100",
    "robot_type": "SO-100",
    "status": "AVAILABLE",
    "control_url": "wss://robots.example.com/so100/control",
    "stream_url": "https://robots.example.com/so100/stream",
    "hardware_id": "board:local:usb-1",
    "last_online": "2026-08-09T10:12:00.000Z",
    "last_heartbeat": "2026-08-09T10:12:00.000Z",
    "total_hours": 12.5,
    "tags": ["lab"],
    "notes": null,
    "created_at": "2026-07-01T09:00:00.000Z"
  }
]

Жаңа роботты тіркеп, оның id мәнін қайтарады. Мотор тақтасының жабдық идентификаторы тек бір роботқа тиесілі бола алады; қайшылық 409 күйімен қабылданбайды.

Аутентификацияланған пайдаланушының client профилін қайтарады.

client профиль өрістерін жаңартады.

Клиенттің бұлттық датасеттерін эпизод саны мен өлшемдерімен тізеді.

Клиенттің ай сайынғы шот-фактураларын тізеді.

Клиент бақылау тақтасы үшін пайдалану статистикасын қайтарады.

Аутентификацияланған пайдаланушының operator профилін қайтарады.

operator профилін жасайды немесе жаңартады.

Қазіргі уақытта қолжетімді және оператордың сертификаттарына сәйкес келетін роботтарды тізеді.

Оператордың сертификаттау сұраныстары мен олардың күйін тізеді.

Робот түрі үшін сертификаттауды сұрайды.

Оператордың апталық қолжетімділік кестесін қайтарады.

Апталық қолжетімділік кестесін жаңартады.

Оператордың ағымдағы қолжетімділігін қайтарады.

Оператор бақылау тақтасы үшін табыс пен сессия статистикасын қайтарады.

Аутентификацияланған пайдаланушы үшін сессияларды тізеді. Операторлар өздері басқарған сессияларды көреді; клиенттер өз роботтарындағы сессияларды көреді. Екі көріністегі өрістер жиынтығы аздап ерекшеленеді: client көрінісіне episodes_collected пен data_collected_mb кіреді, operator көрінісіне operator_earnings_cents кіреді.

curl 'https://www.ay-robots.com/api/sessions?status=COMPLETED&limit=10' \
  -H 'Authorization: Bearer ayr_live_your_key_here'

{
  "sessions": [
    {
      "id": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
      "status": "COMPLETED",
      "started_at": "2026-08-08T14:00:12.000Z",
      "ended_at": "2026-08-08T14:47:31.000Z",
      "duration_minutes": 47,
      "client_charge_cents": 1175,
      "episodes_collected": 23,
      "data_collected_mb": 210.4,
      "rating": 5,
      "created_at": "2026-08-08T13:59:58.000Z",
      "robot_id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
      "robot_name": "Lab SO-100",
      "robot_type": "SO-100",
      "operator_name": "Jane D."
    }
  ]
}

Қолжетімді роботта қашықтан басқару сессиясын бастайды. Operator рөлі талап етіледі: клиенттер сессия бастай алмайды. Оператор бір мезгілде ең көбі бір ACTIVE немесе PAUSED сессиясын ұстай алады, ал роботтың ағымдағы күйі AVAILABLE болуы керек. Дереу бастаумен робот IN_SESSION күйіне ауысады, клиентке хабарлама жіберіледі.

curl -X POST https://www.ay-robots.com/api/sessions \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"robotId": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11"}'

{
  "sessionId": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
  "status": "ACTIVE"
}

Бір сессияны деректерімен қайтарады.

Сессия өмірлік циклін жаңартады: кідірту, жалғастыру, аяқтау және сабақтас әрекеттер.

Сессияны ұзартуды сұрайды. Мұны тек сессияға иелік ететін клиент шақыра алады, сессия ACTIVE болуы керек. Сұраныс сессия оқиғасы ретінде тіркеледі, операторға хабарлама жіберіледі; ұзарту оператор оған әрекет жасағанда жүзеге асады.

curl -X POST https://www.ay-robots.com/api/sessions/6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30/extend \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"additionalMinutes": 30}'

{
  "message": "Extension request sent to operator"
}

Сессияның чат хабарламаларын тізеді.

Сессияда чат хабарламасын жібереді.

Аяқталған сессияны 1-ден 5 жұлдызға дейінгі шкала бойынша, міндетті емес пікірмен бағалайды.

Сессия деректерін экспорттайды.

Клиент төлемдері үшін пайдаланылатын Stripe клиентін жасайды немесе қайтарады.

Оператордың Stripe Connect есептік жазбасының күйін қайтарады.

Оператор төлемдері үшін Stripe Connect тіркелуін бастайды.

Төлем әдісін сақтау үшін Stripe SetupIntent жасайды.

Төлем әдістері мен шот-фактураларды басқару үшін Stripe төлем порталы сессиясын жасайды.

Аутентификацияланған оператор үшін төлем ақпаратын қайтарады.

Жиналған табыстың төлемін сұрайды. Ең аз төлем 10,00 EUR.

Stripe webhook оқиғаларын қабылдайды. Stripe шақырады, API клиенттері емес.

API мен оның дерекқор байланысы үшін сау-саулық тексерісі. Екеуі де дұрыс болса 200 қайтарады; дерекқор тексерісі сәтсіз болса, дәл сол пішін status пен db мәндері error, ал HTTP күйі 503 болып қайтарылады.

curl https://www.ay-robots.com/api/health

{
  "status": "ok",
  "db": "ok",
  "timestamp": "2026-08-09T10:12:00.000Z"
}

Қолдау көрсетілетін робот моделі туралы жария ақпаратты қайтарады.

Ағымдағы жария баға тарифтерін қайтарады.

Байланыс формасының хабарламасын жібереді. Хабарлама алдымен сақталады, содан кейін электрондық поштамен жеткізіледі, сондықтан уақытша поштаның жұмыс істемеуі оны жоғалтпайды: бұл жағдайда жауап stored true және delivered false деп хабарлайды, жеткізу операциялық түрде қайталанады.

curl -X POST https://www.ay-robots.com/api/contact \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "category": "Technical Support",
    "subject": "SO-100 pairing question",
    "message": "My arm shows as offline after pairing."
  }'

{
  "success": true,
  "message": "Message sent successfully",
  "id": "b1f2c3d4-0000-0000-0000-000000000000",
  "stored": true,
  "delivered": true
}

Платформада әлі жоқ робот түрі үшін қолдау сұрайды.

Платформаның жария статистикасын қайтарады.