Проектирование API

Макеты приложения при взаимодействии по API

loading...

Схема макетов экранов приложения и переходом между ними с отображением end-points и сущностей данных.

OpenAPI спецификация

• Items
  • getСписок предметов
  • postСоздать предмет
  • getКарточка предмета
  • patchИзменить предмет
  • putОбновить фото места
• Sharing
  • getПолучить ссылку для общего доступа
  • delЗакрыть общий доступ
• Places
  • postОтправить 3д модель
  • getПросмотр места предмета

API docs by Redocly

SmartFindAR API (1.1.0)

Download OpenAPI specification:Download

API приложения для поиска вещей с использованием AR.

Items

Список предметов

Возвращает краткий список предметов (1 фото, название, описание, статус, id места).

Responses

https://api.smartfindar.io/v1/items

Response samples

• 200
• 401
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "title": "Ваза",
  • "description": "Синяя хрустальная ваза",
  • "main_photo": "http://example.com",
  • "place_id": 0,
  • "status": "at_place"

  }

]

Создать предмет

Request Body schema: application/json

required

id required	integer Уникальный ID предмета.
title required	string Название предмета.
description	string Описание предмета.
main_photo required	string <uri> Ссылка на главное фото предмета.
place_id	integer ID помещения, где находится предмет.
status required	string Default: "at_place" Enum: "at_place" "got" "lost" Текущее состояние предмета
photos required	Array of strings <uri> [ items <uri > ] Полный список фотографий предмета.
	object (Location)

Responses

https://api.smartfindar.io/v1/items

Request samples

• Payload

Content type

application/json

{

• "id": 0,
• "title": "Ваза",
• "description": "Синяя хрустальная ваза",
• "main_photo": "http://example.com",
• "place_id": 0,
• "status": "at_place",
• "photos": [

  • "http://example.com"

  ],
• "location": {

  • "place_id": 0,
  • "cord_x": 0,
  • "cord_y": 0,
  • "cord_z": 0

  }

}

Response samples

• 401
• 404

Content type

application/json

{

• "details": "string",
• "error": "string",
• "message": "string"

}

Карточка предмета

Возвращает полную информацию о предмете, включая координаты.

path Parameters

id required

integer

Responses

https://api.smartfindar.io/v1/items/{id}

Response samples

• 200
• 401
• 404

Content type

application/json

{

• "id": 0,
• "title": "Ваза",
• "description": "Синяя хрустальная ваза",
• "main_photo": "http://example.com",
• "place_id": 0,
• "status": "at_place",
• "photos": [

  • "http://example.com"

  ],
• "location": {

  • "place_id": 0,
  • "cord_x": 0,
  • "cord_y": 0,
  • "cord_z": 0

  }

}

Изменить предмет

path Parameters

id required

integer

Request Body schema: application/json

id required	integer Уникальный ID предмета.
title required	string Название предмета.
description	string Описание предмета.
main_photo required	string <uri> Ссылка на главное фото предмета.
place_id	integer ID помещения, где находится предмет.
status required	string Default: "at_place" Enum: "at_place" "got" "lost" Текущее состояние предмета
photos required	Array of strings <uri> [ items <uri > ] Полный список фотографий предмета.
	object (Location)

Responses

https://api.smartfindar.io/v1/items/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 0,
• "title": "Ваза",
• "description": "Синяя хрустальная ваза",
• "main_photo": "http://example.com",
• "place_id": 0,
• "status": "at_place",
• "photos": [

  • "http://example.com"

  ],
• "location": {

  • "place_id": 0,
  • "cord_x": 0,
  • "cord_y": 0,
  • "cord_z": 0

  }

}

Response samples

• 401
• 404

Content type

application/json

{

• "details": "string",
• "error": "string",
• "message": "string"

}

Обновить фото места

Request Body schema: multipart/form-data

required

file	string <binary> Фотография места в формате JPEG/PNG.

Responses

https://api.smartfindar.io/v1/items/{id}/place/photo

Response samples

• 401
• 404
• 429

Content type

application/json

{

• "details": "string",
• "error": "string",
• "message": "string"

}

Sharing

Получить ссылку для общего доступа

path Parameters

id required

integer

Responses

https://api.smartfindar.io/v1/items/{id}/share

Response samples

• 200

Content type

application/json

{

• "share_url": "string"

}

Закрыть общий доступ

path Parameters

id required

integer

Responses

https://api.smartfindar.io/v1/items/{id}/share

Response samples

• 401
• 404
• 405

Content type

application/json

{

• "details": "string",
• "error": "string",
• "message": "string"

}

Places

Отправить 3д модель

Отправка данных отсканированного помещения.

Request Body schema: multipart/form-data

required

file	object <binary> 3д модель помещения.

Responses

https://api.smartfindar.io/v1/place

Response samples

• 401
• 404

Content type

application/json

{

• "details": "string",
• "error": "string",
• "message": "string"

}

Просмотр места предмета

Загрузка и отображение 3D модели помещения.

path Parameters

id required

integer

Responses

https://api.smartfindar.io/v1/place/{id}/model

Response samples

• 200
• 401
• 404

Content type

application/json

{

• "id": 0,
• "name": "Гостиная",
• "model_url": "http://example.com"

}