İçeriğe geç
Miraç Özdemir Geliştirici

Araçları listele

GET
/v1/public/tools
curl --request GET \
  --url 'https://api.mirac-ozdemir.com/v1/public/tools?page=1&pageSize=20&locale=tr'

Yayında ve arama motorlarına açık araçları başlığa göre sıralı ve sayfalı döndürür. category verilirse o kategori ve alt kategorilerindeki araçlar listelenir. Her öğedeki key, tanım ve hesaplama uçlarında kullanılacak kalıcı anahtardır.

Parameters

Bölüm başlığı “Parameters”

Query Parameters

Bölüm başlığı “Query Parameters”
page
integer
default: 1 >= 1 <= 10000

Example 

1

Sayfa numarası, 1’den başlar.

pageSize
integer
default: 20 >= 1 <= 100

Example 

20

Sayfa başına kayıt (varsayılan 20).

locale
required
string
Allowed values: tr en

İçerik dili: tr veya en. Zorunludur; araç o dilde yoksa 404 döner.

category

Category key; a main category also lists its subcategories

string
>= 2 characters <= 64 characters /^[a-z0-9]+(-[a-z0-9]+)*$/

Kategori key’i; ana kategori verilirse alt kategorilerindeki araçlar da dahil edilir.

Responses

Bölüm başlığı “Responses”

200

Bölüm başlığı “200”

Araç listesi

Media typeapplication/json
object
data
required
Array<object>
object
toolId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
key
required

Kalıcı araç anahtarı (ör. kdv); tüm ortamlarda aynıdır.

string
locale
required
string
Allowed values: tr en
slug
required
string
path
required
string
title
required
string
shortDescription
required
string
category
required
string
availability
required
string
Allowed values: ONLINE MAINTENANCE
score
required
number
meta
required
object
page
required
integer
>= 1 <= 9007199254740991
pageSize
required
integer
>= 1 <= 9007199254740991
total
required
integer
<= 9007199254740991
totalPages
required
integer
>= 1 <= 9007199254740991

Example 

{
  "data": [
    {
      "key": "kdv",
      "locale": "tr",
      "availability": "ONLINE"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 100,
    "totalPages": 5
  }
}

Headers

Bölüm başlığı “Headers”
X-Request-Id
string

İstek kimliği; destek taleplerinde iletin.

422

Bölüm başlığı “422”

Doğrulama, hesaplama veya oran hatası

Media typeapplication/json

Tüm hatalarda aynı zarf. details yapısı koda göre değişir (bkz. API açıklamasındaki tablo).

object
error
required
object
code
required

Makine tarafından okunacak sabit kod; mantığınızı buna göre kurun.

string
Allowed values: VALIDATION_ERROR NOT_FOUND CONFLICT CALCULATION_ERROR RATE_UNAVAILABLE PAYLOAD_TOO_LARGE RATE_LIMITED TIMEOUT SERVICE_UNAVAILABLE MAINTENANCE INTERNAL_ERROR
message
required

İngilizce, insan tarafından okunacak açıklama; değişebilir.

string
details

fields[] (girdi hataları), issues[] (istek şeması), reason, currentVersion, retryAfterSeconds, rates, asOf.

object
key
additional properties
requestId
required

X-Request-Id yanıt başlığıyla aynı değer.

string | null

Examples

ExampleinvalidParameter

Geçersiz parametre

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request",
    "details": {
      "issues": [
        {
          "path": "locale",
          "message": "Invalid option: expected one of \"tr\"|\"en\"",
          "code": "invalid_value"
        }
      ]
    }
  },
  "requestId": "5f0c6a5e-2b7e-4a7b-9a51-0d9f0c1f7e21"
}

Headers

Bölüm başlığı “Headers”
X-Request-Id
string

İstek kimliği; destek taleplerinde iletin.

500

Bölüm başlığı “500”

Beklenmeyen sunucu hatası

Media typeapplication/json

Tüm hatalarda aynı zarf. details yapısı koda göre değişir (bkz. API açıklamasındaki tablo).

object
error
required
object
code
required

Makine tarafından okunacak sabit kod; mantığınızı buna göre kurun.

string
Allowed values: VALIDATION_ERROR NOT_FOUND CONFLICT CALCULATION_ERROR RATE_UNAVAILABLE PAYLOAD_TOO_LARGE RATE_LIMITED TIMEOUT SERVICE_UNAVAILABLE MAINTENANCE INTERNAL_ERROR
message
required

İngilizce, insan tarafından okunacak açıklama; değişebilir.

string
details

fields[] (girdi hataları), issues[] (istek şeması), reason, currentVersion, retryAfterSeconds, rates, asOf.

object
key
additional properties
requestId
required

X-Request-Id yanıt başlığıyla aynı değer.

string | null

Example 

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Tool not found"
  },
  "requestId": "5f0c6a5e-2b7e-4a7b-9a51-0d9f0c1f7e21"
}

Headers

Bölüm başlığı “Headers”
X-Request-Id
string

İstek kimliği; destek taleplerinde iletin.