Чаты - Для разработчиков

Примечания

Для опытных пользователей

Передавайте API-ключ как Bearer-токен в заголовке Authorization. Создать API-ключ.

Список

URL API:

GET

https://nexchat.store/api/v1/chats

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

curl --location --request GET 'https://nexchat.store/api/v1/chats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

дополнительно string

Например: название документа, шаблона или ключевая фраза.

search_by

дополнительно string

Поиск по. Возможные значения: name для Имя. По умолчанию: name.

favorite

дополнительно boolean

Фильтр по избранному.

sort_by

дополнительно string

Сортировать по. Возможные значения: id для Дата создания, name для Имя. По умолчанию: id.

sort

дополнительно string

Сортировать. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.

per_page

дополнительно integer

Элементов на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.

Открыть

URL API:

GET

https://nexchat.store/api/v1/chats/{id}

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

curl --location --request GET 'https://nexchat.store/api/v1/chats/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Создать

URL API:

POST

https://nexchat.store/api/v1/chats

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

curl --location --request POST 'https://nexchat.store/api/v1/chats' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'

Параметр

Тип

Описание

name

требуется string

Например: Идеи для контент-плана

behavior

дополнительно string

Например: отвечай кратко, по делу и на русском языке

Сохранить

URL API:

PUT PATCH

https://nexchat.store/api/v1/chats/{id}

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

curl --location --request PUT 'https://nexchat.store/api/v1/chats/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

name

дополнительно string

Например: Идеи для контент-плана

behavior

дополнительно string

Например: отвечай кратко, по делу и на русском языке

favorite

дополнительно boolean

Показывает, добавлен ли чат в избранное.

Удалить

URL API:

DELETE

https://nexchat.store/api/v1/chats/{id}

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

curl --location --request DELETE 'https://nexchat.store/api/v1/chats/{id}' \
--header 'Authorization: Bearer {api_key}'