Kategori ağacı

GET

/v1/public/categories

const url = 'https://api.mirac-ozdemir.com/v1/public/categories?locale=tr';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.mirac-ozdemir.com/v1/public/categories?locale=tr'

Aktif ana kategoriler ve alt kategorileri, yayındaki araç sayılarıyla. Kategori key değerini /tools ve /search uçlarında category filtresi olarak kullanın.

Parameters

Query Parameters

locale

required

string

Allowed values: tr en

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

Responses

200

Kategori ağacı

application/json

object

data

required

Array<object>

object

key

required

string

locale

required

string

Allowed values: tr en

slug

required

string

path

required

string

name

required

string

description

required

string

ogImage

required

string

Allowed values: default tax finance math conversion date health

indexable

required

boolean

toolCount

required

Published, indexable tools listed in the category, including its subcategories

integer

>= -9007199254740991 <= 9007199254740991

availability

required

MAINTENANCE: the category page answers 503 until it is back online

string

Allowed values: ONLINE MAINTENANCE

alternates

required

Array<object>

object

locale

required

string

Allowed values: tr en

slug

required

string

path

required

string

updatedAt

required

string

children

required

Array<object>

object

key

required

string

locale

required

string

Allowed values: tr en

slug

required

string

path

required

string

name

required

string

description

required

string

ogImage

required

string

Allowed values: default tax finance math conversion date health

indexable

required

boolean

toolCount

required

Published, indexable tools listed in the category, including its subcategories

integer

>= -9007199254740991 <= 9007199254740991

availability

required

MAINTENANCE: the category page answers 503 until it is back online

string

Allowed values: ONLINE MAINTENANCE

alternates

required

Array<object>

object

locale

required

string

Allowed values: tr en

slug

required

string

path

required

string

updatedAt

required

string

Example

{
  "data": [
    {
      "locale": "tr",
      "ogImage": "default",
      "availability": "ONLINE",
      "alternates": [
        {
          "locale": "tr"
        }
      ],
      "children": [
        {
          "locale": "tr",
          "ogImage": "default",
          "availability": "ONLINE",
          "alternates": [
            {
              "locale": "tr"
            }
          ]
        }
      ]
    }
  ]
}

Headers

X-Request-Id

string

İstek kimliği; destek taleplerinde iletin.

422

Doğrulama, hesaplama veya oran hatası

application/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

invalidParameter

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

X-Request-Id

string

İstek kimliği; destek taleplerinde iletin.

500

Beklenmeyen sunucu hatası

application/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

X-Request-Id

string

İstek kimliği; destek taleplerinde iletin.