Категории

Свойства категории

id - идентификатор категории

• Строка до 64 символов
• Обязательно к заполнению

name - наименование категории

• Строка до 64 символов
• Обязательно к заполнению

Примеры

{
  "id":  "bread",
  "name": "Bread & Loafs"
}

Показать список категорий

GET /v2/categories

Пример запроса

curl https://api.snarta.com/v2/categories \
  -X GET \
  -H "Authorization: Bearer 9e248657-5706-4792-9bff-3528e5b83faa"

Успешный ответ

{
  "categories": [
    { "id":  "cakes", "name": "Cakes and pies" },
    { "id":  "bread", "name": "Bread & Loafs" }
  ]
}

Показать категорию

GET /v2/categories/[id]

Параметры URL

id — идентификатор категории

• Строка до 64 символов
• Обязательно к заполнению

Пример запроса

curl https://api.snarta.com/v2/categories/bread \
  -X GET \
  -H "Authorization: Bearer 9e248657-5706-4792-9bff-3528e5b83faa"

Успешный ответ

{
  "category": {
    "id":  "bread",
    "name": "Bread & Loafs"
  }
}

Ответы с ошибкой

{}

Создать категорию

POST /v2/categories

Пример запроса

curl https://api.snarta.com/v2/categories \
  -X POST \
  -H "Authorization: Bearer 9e248657-5706-4792-9bff-3528e5b83faa" \
  -d '{"id": "bread", "name": "Bread & Loafs"}'

Успешный ответ

{
  "category": {
    "id":  "bread",
    "name": "Bread & Loafs"
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.",
  "name": "The name must be a string."
}

{
  "id": "Duplicate value."
}

Изменить категорию

PUT /v2/categories/[id]

id — идентификатор категории

• Строка до 64 символов
• 200 Ok”

Пример запроса

curl https://api.snarta.com/v2/categories/bread \
  -X PUT \
  -H "Authorization: Bearer 9e248657-5706-4792-9bff-3528e5b83faa" \
  -d '{"id": "bread", "name": "Bread & Loafs"}' 

Успешный ответ

{
  "category": {
    "id":  "bread",
    "name": "Bread & Loafs"
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.",
  "name": "The name must be a string."
}

{}