ImageBan.ru - API сервиса ImageBan.ru

Сервис Album

Создание альбома.

POST https://api.imageban.ru/v1/album

Описание: Создаёт новый альбом
В параметре images вы можете указать идентификатор изображения (ID), значения указываются через запятую или вы можете отправить параметр как массив images[] Пример: images=xxxxxxx,yyyyyyy,zzzzzzz или images[]=xxxxxxx images[]=yyyyyyy images[]=zzzzzzz

Заголовок:

Authorization Bearer {SECRET_KEY}

Тело formdata

album_name Имя альбома (Обязательный параметр)
album_desc Описание альбома (Необязательный параметр)
album_type Тип альбома (public, hidden, secret) (Необязательный параметр)
album_pass Пароль для доступа к альбому, если альбом имеет тип secret (Необязательный параметр)
images ID изображений, которые переместятся в данный альбом (Необязательный параметр)

Пример:

curl --location 'https://api.imageban.ru/v1/album' \
--header 'Authorization: Bearer {SECRET_KEY}' \
--form 'album_name=Новый альбом' \
--form 'album_desc=Описание альбома' \
--form 'album_type=hidden' \
--form 'images=xxxxxxx,yyyyyyy,zzzzzzz'

Ответ:

{
    "data": {
        "id": "2E9BJVK"
    },
    "success": true,
    "status": 200
}

Возвращаемые данные:

Ключ	Формат	Описание
id	string	id созданного альбома

Коды ошибок:

Код	Текст ошибки	Описание
400	The album with the same name already exists.	Альбом с таким именем уже существует
401	The album name is not specified.	Не указан album_name

Получение информации об альбоме.

GET https://api.imageban.ru/v1/api/album/{ID}

Описание: Получает всю информацию об альбоме и изображениях хранящихся в нем (в {ID} указывается id альбома).

Заголовок:

Authorization Bearer {SECRET_KEY}

Пример:

curl --location -g 'https://api.imageban.ru/v1/album/J1VSUhz' \
--header 'Authorization: Bearer {SECRET_KEY}'

Ответ:

{
    "data": {
        "id": "J1VSUhz",
        "name": "Test Album",
        "description": "API test",
        "create_date": "2023.07.19",
        "create_time": "14:11:38",
        "privacy": "public",
        "image_count": "2",
        "link": "https://imageban.ru/a/J1VSUhz",
        "image": [
            {
                "id": "d0oId8A",
                "date": "2023.07.19",
                "name": "6a9429a1a9abd0c45b19aadd8997f626.jpg",
                "server": "i1.imageban.ru",
                "views": "0",
                "description": "",
                "img_name": "img4.jpg",
                "favorite": false,
                "size": "595514",
                "resolution": "1920x1200",
                "link": "https://i1.imageban.ru/out/2023/07/19/6a9429a1a9abd0c45b19aadd8997f626.jpg",
                "short_link": "http://ibn.im/i/d0oId8A"
            },
            {
                "id": "9Xl3lw9",
                "date": "2023.07.19",
                "name": "ca0344b4b091b6265bd019d063dec8d4.jpg",
                "server": "i1.imageban.ru",
                "views": "0",
                "description": "",
                "img_name": "img13.jpg",
                "favorite": false,
                "size": "1277444",
                "resolution": "3840x1200",
                "link": "https://i1.imageban.ru/out/2023/07/19/ca0344b4b091b6265bd019d063dec8d4.jpg",
                "short_link": "http://ibn.im/i/9Xl3lw9"
            }
        ]
    },
    "success": true,
    "status": 200
}

Возвращаемые данные:

Ключ	Формат	Описание
id	string	id альбома
name	string	Название альбома
description	string	Описание альбома
create_date	string	Дата создания альбома
create_time	string	Время создания альбома (МСК)
privacy	string	Тип альбома
image_count	integer	Количество изображений в альбоме
link	string	Ссылка на альбом
image	array	Массив всех изображений в альбоме

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
403	Invalid secret key	Неверный SECRET_KEY

Получение информации об изображениях в альбоме.

GET https://api.imageban.ru/v1/api/album/{ID}/images

Описание: Получает все данные об изображениях в альбоме.

Заголовок:

Authorization Bearer {SECRET_KEY}

Пример:

curl --location -g 'https://api.imageban.ru/v1/album/{ID}/images' \
--header 'Authorization: Bearer {SECRET_KEY}'

Возвращаемые данные:

Возвращает данные: Image

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
403	Invalid secret key	Неверный SECRET_KEY

Изменение альбома

PUT https://api.imageban.ru/v1/album/{ID}

Описание: Изменяет информацию об альбоме и изображений в нём

В параметре images вы можете указать идентификатор изображения (ID), значения указываются через запятую или вы можете отправить параметр как массив images[] Пример: images=xxxxxxx,yyyyyyy,zzzzzzz или images[]=xxxxxxx images[]=yyyyyyy images[]=zzzzzzz

Заголовок:

Authorization Bearer {SECRET_KEY}

Тело formdata

album_name Имя альбома (Необязательный параметр)
album_desc Описание альбома (Необязательный параметр)
album_type Тип альбома (public, hidden, secret) (Необязательный параметр)
album_pass Пароль для доступа к альбому, если альбом имеет тип secret (Необязательный параметр)
images ID изображений, которые переместятся в данный альбом (Необязательный параметр)

Пример:

curl --location -g --request PUT 'https://api.imageban.ru/v1/album/{ID}' \
--header 'Authorization: Bearer {SECRET_KEY}' \
--form 'album_type=hidden' \
--form 'images=xxxxxxx,yyyyyyy,zzzzzzz'

Ответ:

{
    "data": true,
    "success": true,
    "status": 200
}

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
404	The album with the same name already exists.	Альбом с таким именем уже существует
403	Invalid secret key	Неверный SECRET_KEY

Добавление изображений в альбом

PUT https://api.imageban.ru/v1/album/{ID}

Описание: Добавляет изображения в альбом

В параметре images вы можете указать идентификатор изображения (ID), значения указываются через запятую или вы можете отправить параметр как массив images[] Пример: images=xxxxxxx,yyyyyyy,zzzzzzz или images[]=xxxxxxx images[]=yyyyyyy images[]=zzzzzzz

Заголовок:

Authorization Bearer {SECRET_KEY}

Тело formdata

images ID изображений, которые переместятся в данный альбом

Пример:

curl --location -g --request PUT 'https://api.imageban.ru/v1/album/{ID}' \
--header 'Authorization: Bearer {SECRET_KEY}' \
--form 'images=xxxxxxx,yyyyyyy,zzzzzzz'

Ответ:

{
    "data": true,
    "success": true,
    "status": 200
}

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
403	Invalid secret key	Неверный SECRET_KEY

Удаление изображений из альбома

POST https://api.imageban.ru/v1/album/{ID}/delete_image

Описание: Удаляет изображения из альбома (переносит в "Мои изображения")"

В параметре images вы можете указать идентификатор изображения (ID), значения указываются через запятую или вы можете отправить параметр как массив images[] Пример: images=xxxxxxx,yyyyyyy,zzzzzzz или images[]=xxxxxxx images[]=yyyyyyy images[]=zzzzzzz

Заголовок:

Authorization Bearer {SECRET_KEY}

Тело formdata

images ID изображений, которые переместятся в данный альбом

Пример:

curl --location 'https://api.imageban.ru/v1/album/{ID}/delete_images' \
--header 'Authorization: Bearer {SECRET_KEY}' \
--form 'images=xxxxxxx,yyyyyyy,zzzzzzz'

Ответ:

{
    "data": true,
    "success": true,
    "status": 200
}

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
403	Invalid secret key	Неверный SECRET_KEY
404	No images ID	Не указаны ID изображений

Удаление альбома

DELETE https://api.imageban.ru/v1/album/{ID}

Описание: Удаляет альбом и изображения в нём

Заголовок:

Authorization Bearer {SECRET_KEY}

Пример:

curl --location -g --request DELETE 'https://api.imageban.ru/v1/album/{ID}' \
--header 'Authorization: Bearer {SECRET_KEY}'

Ответ:

{
    "data": true,
    "success": true,
    "status": 200
}

Коды ошибок:

Код	Текст ошибки	Описание
400	Album does not exist	Альбом не существует
403	Invalid secret key	Неверный SECRET_KEY