API başvurusu

Özel Mini App

Bu gruptaki 6 uç.

Özel Mini App taleplerini listeler

GET/api/v1/custom-miniapps

En yeni önce. Teklif ve bağlantılar panelde göründükleri aşamalarda döner. Kapsam: miniapps:read.

Kapsam
miniapps:read
SDK metodu
listCustomMiniAppRequests · list_custom_mini_app_requests
MCP aracı
listCustomMiniAppRequestssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/custom-miniapps?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "yeni",
      "title": "Örnek",
      "description": "string",
      "examples": "string",
      "budget": "string",
      "takes_payment": true,
      "handles_personal_data": true,
      "quote_amount_cents": 1,
      "monthly_amount_cents": 1,
      "delivery_days": 1,
      "quote_note": "string",
      "payment_url": "https://example.com/a.png",
      "preview_url": "https://example.com/a.png",
      "delivery_url": "https://example.com/a.png",
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Özel Mini App talebi açar

POST/api/v1/custom-miniapps

Talep Hiboty ekibine iletilir, teklifi ekip hazırlar. Saatte en fazla 5 talep (429); açık talep sınırı doluysa 409 open_limit döner. Yönetici yetkisi gerekir. Kapsam: miniapps:write.

Kapsam
miniapps:write
SDK metodu
createCustomMiniAppRequest · create_custom_mini_app_request
MCP aracı
createCustomMiniAppRequestdış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
titlestringevetlen 3–120
descriptionstringevetlen 30–4000
examplesstringhayırlen ≤ 1000
budgetstringhayırlen ≤ 60
takes_paymentbooleanhayır
handles_personal_databooleanhayır

Örnek istek

curl -X POST "https://hiboty.com/api/v1/custom-miniapps" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"title":"Randevu uygulaması","description":"Müşterilerin hizmet seçip randevu alabildiği, hatırlatma gönderen bir uygulama istiyoruz.","budget":"500 USD","takes_payment":false,"handles_personal_data":true}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "yeni",
    "title": "Örnek",
    "description": "string",
    "examples": "string",
    "budget": "string",
    "takes_payment": true,
    "handles_personal_data": true,
    "quote_amount_cents": 1,
    "monthly_amount_cents": 1,
    "delivery_days": 1,
    "quote_note": "string",
    "payment_url": "https://example.com/a.png",
    "preview_url": "https://example.com/a.png",
    "delivery_url": "https://example.com/a.png",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.open_limit
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Özel Mini App talebi ayrıntısı

GET/api/v1/custom-miniapps/{id}

Yalnız bu organizasyonun talepleri görünür; ekibin iç notları dönmez. Kapsam: miniapps:read.

Kapsam
miniapps:read
SDK metodu
getCustomMiniAppRequest · get_custom_mini_app_request
MCP aracı
getCustomMiniAppRequestsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

curl -X GET "https://hiboty.com/api/v1/custom-miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "yeni",
    "title": "Örnek",
    "description": "string",
    "examples": "string",
    "budget": "string",
    "takes_payment": true,
    "handles_personal_data": true,
    "quote_amount_cents": 1,
    "monthly_amount_cents": 1,
    "delivery_days": 1,
    "quote_note": "string",
    "payment_url": "https://example.com/a.png",
    "preview_url": "https://example.com/a.png",
    "delivery_url": "https://example.com/a.png",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Teklifi kabul eder

POST/api/v1/custom-miniapps/{id}/accept

Yalnız teklif aşamasında geçerlidir, başka durumda 409 invalid_status döner. Kabulden sonra ödeme bağlantısı iletilir ve iptal ekip üzerinden yürür. Yönetici yetkisi gerekir. Kapsam: miniapps:write.

Kapsam
miniapps:write
SDK metodu
acceptCustomMiniAppQuote · accept_custom_mini_app_quote
MCP aracı
acceptCustomMiniAppQuotedış etkiligeri alınamaz

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Örnek istek

curl -X POST "https://hiboty.com/api/v1/custom-miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6/accept" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "yeni",
    "title": "Örnek",
    "description": "string",
    "examples": "string",
    "budget": "string",
    "takes_payment": true,
    "handles_personal_data": true,
    "quote_amount_cents": 1,
    "monthly_amount_cents": 1,
    "delivery_days": 1,
    "quote_note": "string",
    "payment_url": "https://example.com/a.png",
    "preview_url": "https://example.com/a.png",
    "delivery_url": "https://example.com/a.png",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.invalid_status
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Önizlemeyi onaylar

POST/api/v1/custom-miniapps/{id}/approve-preview

Yalnız önizleme aşamasında geçerlidir, başka durumda 409 invalid_status döner. Yönetici yetkisi gerekir. Kapsam: miniapps:write.

Kapsam
miniapps:write
SDK metodu
approveCustomMiniAppPreview · approve_custom_mini_app_preview
MCP aracı
approveCustomMiniAppPreviewdış etkiligeri alınamaz

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Örnek istek

curl -X POST "https://hiboty.com/api/v1/custom-miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve-preview" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "yeni",
    "title": "Örnek",
    "description": "string",
    "examples": "string",
    "budget": "string",
    "takes_payment": true,
    "handles_personal_data": true,
    "quote_amount_cents": 1,
    "monthly_amount_cents": 1,
    "delivery_days": 1,
    "quote_note": "string",
    "payment_url": "https://example.com/a.png",
    "preview_url": "https://example.com/a.png",
    "delivery_url": "https://example.com/a.png",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.invalid_status
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Talebi iptal eder

POST/api/v1/custom-miniapps/{id}/cancel

Teklif kabul edilmeden önce geçerlidir, başka durumda 409 invalid_status döner. Yönetici yetkisi gerekir. Kapsam: miniapps:write.

Kapsam
miniapps:write
SDK metodu
cancelCustomMiniAppRequest · cancel_custom_mini_app_request
MCP aracı
cancelCustomMiniAppRequestdış etkiligeri alınamaz

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Örnek istek

curl -X POST "https://hiboty.com/api/v1/custom-miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "yeni",
    "title": "Örnek",
    "description": "string",
    "examples": "string",
    "budget": "string",
    "takes_payment": true,
    "handles_personal_data": true,
    "quote_amount_cents": 1,
    "monthly_amount_cents": 1,
    "delivery_days": 1,
    "quote_note": "string",
    "payment_url": "https://example.com/a.png",
    "preview_url": "https://example.com/a.png",
    "delivery_url": "https://example.com/a.png",
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.invalid_status
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.