> For the complete documentation index, see [llms.txt](https://docs.ncteam.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ncteam.io/nocodb/swagger/kak-otpravlyat-zaprosy.md).

# Как отправлять запросы

## Обзор интерфейса

{% hint style="info" %}
Все примеры показаны с [авторизованным](https://www.notion.so/Swagger-9cf3b04436ec4d5eb73eb2de84975a49?pvs=21) Swagger
{% endhint %}

В Swagger основной функциональной единицей является HTTP-запрос, который также называют конечной точкой, ручкой, маршрутом.

В NocoDB запросы группируются по таблицам.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FC32bdDijUrH50PVEcCgN%2Fimage.png?alt=media&#x26;token=7026c17a-7cf1-40a7-8a1d-a0d91e18ec9f" alt=""><figcaption></figcaption></figure>

## HTTP-запрос

Чтобы поработать с запросом, нужно его развернуть. Для этого достаточно нажать на него:

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FCruG6wOguE83wQUFySoi%2Fimage.png?alt=media&#x26;token=740749f9-4d17-4176-83c4-60fe38e341e5" alt=""><figcaption></figcaption></figure>

## Описание запроса

Каждый запрос имеет описание того, какой функционал он предоставляет.

Оно находится в самом начале:

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FrkvKWUqG7cl22XnrCFU8%2Fimage.png?alt=media&#x26;token=e562cf98-2ee0-4650-a9c0-3d67098edac8" alt=""><figcaption></figcaption></figure>

## Try it out

Чтобы начать тестировать запрос, нужно нажать кнопку “Try it out”.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2F0GY1Iy1vkTqGfieKD0x5%2Fimage.png?alt=media&#x26;token=eda28572-8fab-4337-94e6-95696fec91dc" alt=""><figcaption></figcaption></figure>

Убедитесь, что “замок закрыт”, - это значит, что вы авторизованы. В противном случае, вам следует авторизоваться в Swagger.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FmJyLKyVbbf12LYYulnxv%2Fimage.png?alt=media&#x26;token=71dcbfeb-1e20-426c-b770-2902744401f0" alt=""><figcaption></figcaption></figure>

После нажатия на “Try it out”:

* станут доступными поля ввода параметров и/или тела запроса.

  <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FZYlUrD21Q4faxax9KMSQ%2Fimage.png?alt=media&#x26;token=b6a18545-84be-47bd-b20c-daeadfe00819" alt=""><figcaption></figcaption></figure>
* появится кнопка “Execute”, нажатие которой означает выполнение запроса с введенными параметрами.

  <figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FVrwRozwOu7zLEYlX3ps9%2Fimage.png?alt=media&#x26;token=abd68551-93d6-4eb1-a913-4037288cb076" alt=""><figcaption></figcaption></figure>

## Параметры запроса

Параметры запроса всегда передаются в URL в самом конце после “?” и разделяются “&”, например:

```jsx
...tables/m6uv6qopcq4layy/records**?limit=25&shuffle=0&offset=0**
```

Каждый отдельный параметр имеет название:

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2Fvhg0uGxPJaRQd073sg1p%2Fimage.png?alt=media&#x26;token=63804bcd-38a6-4bd4-aac9-2b27cf3fb99a" alt=""><figcaption></figcaption></figure>

И описание:

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FYJQ5L8BqkXac5STA7aNI%2Fimage.png?alt=media&#x26;token=103fd718-5ea4-47ad-9818-af98c59c2faa" alt=""><figcaption></figcaption></figure>

Параметры всегда являются строкой, которую вы можете указать при тестировании в соответствующее поле:

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FpSQQvMngLo3I1XFAtuMW%2Fimage.png?alt=media&#x26;token=e33b92c0-1041-4fef-a7dc-ba770be4af9d" alt=""><figcaption></figcaption></figure>

Иногда параметр может быть выбран из ограниченного списка вариантов в Swagger (но в запросе параметр указывается так же, как и другие):

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FwlsV2xfYpBbX2JqAc2VG%2Fimage.png?alt=media&#x26;token=b336f8af-830e-4208-8634-b29b0895ae35" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FVzl0BY0qw7gUNdBnxgLg%2Fimage.png?alt=media&#x26;token=94bb827d-6470-48b0-b0f4-0537a50cdfa4" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FvtUPVmigMbeZP59hKzwo%2Fimage.png?alt=media&#x26;token=932f6028-fc02-432d-b601-cb1b54902268" alt=""><figcaption></figcaption></figure>

## Шаблон запроса Curl

{% hint style="info" %}
Можно увидеть только после нажатия “Execute”
{% endhint %}

Этот шаблон удобно копировать, чтобы использовать в других инструментах разработчиков и тестировщиков ( [Curl](https://curl.se), [Postman](https://www.postman.com) ), но для связки с Smartbot Pro и NocoDB он не обязателен.

{% hint style="info" %}
При этом его удобно использовать в связке с n8n (<и сюда надо ссылку на доку n8n про импорт Curl>)
{% endhint %}

## Шаблон URL запроса

{% hint style="info" %}
Можно увидеть только после нажатия “Execute”
{% endhint %}

Удобное поле, которое позволяет копировать сформированный при тестировании запрос.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FCR3B1pBxOgzlOepemmfs%2Fimage.png?alt=media&#x26;token=379f8394-68b5-4040-8eb6-f1e78ab6c0b8" alt=""><figcaption></figcaption></figure>

## Лайфхак с urlencoded

Обратите внимание, что при запросе в примере передается параметр:

```jsx
where=%D0%BB%D1%8F%D0%BB%D1%8F%D0%BB%D1%8F
```

Эти непонятные символы не что иное, как `“ляляля”`.

На самом деле, не обязательно отправлять запрос в таком формате в блоке “Отправить HTTP-запрос”.

Smartbot Pro автоматически преобразует URL в urlencoded формат.

Для того, чтобы URL в сценариях был более читаем, вы можете преобразовать полученный URL при помощи [декодера](https://www.urldecoder.org).

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FbMvLaeJTjaJpAMVQxDhT%2Fimage.png?alt=media&#x26;token=98f3376c-4289-44cf-94c9-acc501408a4d" alt=""><figcaption></figcaption></figure>

## Server response

{% hint style="info" %}
Можно увидеть только после нажатия “Execute”
{% endhint %}

Показывает всю информацию, полученную из ответа от сервера (API).

Code - [код статуса ответа](https://developer.mozilla.org/ru/docs/Web/HTTP/Status) от сервера.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FlGOH72iPfPiXkwwpBnOd%2Fimage.png?alt=media&#x26;token=eb42998a-5ab3-4c32-a4d2-a5fddec87041" alt=""><figcaption></figcaption></figure>

Response body - тело ответа.

В NocoDB API при любых типах запросов возвращает JSON.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2Fsy0HBQvpVGJobcnIlpbH%2Fimage.png?alt=media&#x26;token=8bf66bef-4126-426a-b8bd-e242c3ac5601" alt=""><figcaption></figcaption></figure>

## Responses

В этом разделе изображаются примеры ответов от сервера с различными статусами.

Стоит отметить, что количество примеров не исчерпывающее, обычно ограничивающееся 200 и 400, но эти примеры все равно могут пригодиться для:

* решения сбоев и проблем
* понимания, какой будет ожидаемый ответ от сервера, перед тем, как начать его тестировать.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FJaEytWT2i7hbA7Ytr818%2Fimage.png?alt=media&#x26;token=3476ce2d-2785-4985-9a8f-71ea11b4808f" alt=""><figcaption></figcaption></figure>

## Схемы данных

В самом низу Swagger есть раздел Schemas. Он может быть полезен для понимания, какие поля таблицы (столбцы) какого типа данных.

Для примера, поле Id, обязательное при запросах PATCH, PUT, DELETE, а также GET-запросе конкретной строки из таблицы, имеет тип “integer”, что значит, что это именно целое число, а не строка, дробное число или другой тип.

<figure><img src="https://3293471040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpmSoFQGl5UWE6cvo4nGS%2Fuploads%2FPfnLEflbGP2HqOS9Xiz1%2Fimage.png?alt=media&#x26;token=f24b8caf-c385-48f9-a366-331db3c577bf" alt=""><figcaption></figcaption></figure>
