v1 REST API

API Құжаттамасы

Негізгі URL

Production:https://api.quickname.tech

Сұраныс шектеулері

  • Бір IP мекенжайынан сағатына ең көбі 3 сұраныс. Көбірек қажет болса, бізге хабарласыңыз.
  • Жоба сипаттамасы: 5-тен 1024 таңбаға дейін
POST/v1/request/Сұраныс жасау

Жаңа домен іздеу сұранысын жасайды. Жасалғаннан кейін сұраныс өңдеу кезегіне қойылады.

Сұраныс денесі

ӨрісТүріСипаттама
user_description*stringЖоба сипаттамасы (5-1024 таңба). Неғұрлым толық болса, соғұрлым жақсы ұсыныстар.
zonesstring[]Таңдаулы домен аймақтарының тізімі (мысалы, ["com", "io"]). Міндетті емес.
domain_max_priceintegerДомен бағасының максимумы USD. Міндетті емес.

Сұраныс мысалы

curl -X POST https://api.quickname.tech/v1/request/ \
  -H "Content-Type: application/json" \
  -d '{
    "user_description": "Винтаждық сағаттардың онлайн маркетплейсі",
    "zones": ["com", "io", "tech"],
    "domain_max_price": 100
  }'

Жауап 201 Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Винтаждық сағаттардың онлайн маркетплейсі",
  "zones": ["com", "io", "tech"],
  "domain_max_price": 100,
  "status": "created",
  "results": [],
  "is_valid": true
}
GET/v1/request/{'{'}request_id{'}'}/Сұраныс күйін алу

Домен іздеу сұранысының ағымдағы күйін, соның ішінде өңдеу күйі мен нәтижелерін қайтарады.

Күйлер

created
processing
finished
error

Сұраныс мысалы

curl https://api.quickname.tech/v1/request/123e4567-e89b-12d3-a456-426614174000/

Жауап 200 OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Винтаждық сағаттардың онлайн маркетплейсі",
  "zones": ["com", "io", "tech"],
  "status": "finished",
  "results": [
    {
      "domain": "techmarket.io",
      "price": 45,
      "availability": "available",
      "reasoning": "Технологиялық маркетплейс үшін 'tech' пен 'market' біріктіреді"
    }
  ],
  "is_valid": true
}

Жауап өрістері

Domain нысаны

ӨрісТүріСипаттама
domainstringТолық домен атауы (мысалы, example.com)
priceinteger | nullДомен бағасы USD. Null болуы мүмкін.
availabilitystringКүй: available, unavailable немесе unknown
reasoningstring | nullБұл ұсыныс үшін AI түсіндірмесі

Қате кодтары

КодСипаттама
400Валидация қатесі — сұраныс денесін тексеріңіз
404Сұраныс табылмады немесе мерзімі өтті (24 сағат)
422UUID форматы жарамсыз
429Сұраныс шегі асып кетті (3 сұраныс/сағат)
500Ішкі сервер қатесі