> For the complete documentation index, see [llms.txt](https://support.iafcertsearch.org/api-developer-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.iafcertsearch.org/api-developer-guide/api-ru/api-integration/requests.md).

# Запросы

### Отправка запроса

#### Хост

Хост для запросов веб-API v1 всегда `https://api.iafcertsearch.org/api/client/v1`

{% hint style="info" %}
Все запросы должны быть выполнены через HTTPS. API не поддерживает HTTP.
{% endhint %}

#### Заголовок авторизации

Вы должны предоставить заголовок авторизации, как описано в [Аутентификации](https://github.com/QualityTrade/iaf-docs-api-developer-guide-ru/blob/main/api-integration/broken-reference/README.md).

#### HTTP-глаголы

* `GET` Получение ресурса или группы ресурсов
* `POST` Создание нового ресурса
* `PUT` Обновление существующего ресурса
* `DELETE` Удаление существующего ресурса
* `OPTIONS` Просмотр разрешенных глаголов для конкретного ресурса

#### Заголовок Accept

API возвращает ответы в формате JSON. В настоящее время заголовок accept не требуется, но в будущем может потребоваться. Если он не установлен, API будет использовать `application/json`.

```http
GET https://api.iafcertsearch.org/api/client/v1/endpoint HTTP/1.1
Accept: application/json
```

#### Массив данных

Когда вы отправляете массив данных в запросе `GET`, вы должны включить параметр несколько раз в URL. Имя параметра не требует квадратных скобок.

```http
GET https://api.iafcertsearch.org/api/client/v1/endpoint?parameter=data1&parameter=data2 HTTP/1.1
```

### Форматирование вашего запроса

#### Тело запроса

При отправке данных на ресурс через `POST` или `PUT`, вы должны отправить полезную нагрузку в формате JSON.

```http
POST https://api.iafcertsearch.org/api/client/v1/example/ HTTP/1.1
Content-Type: application/json
```

```json
{
  "name": "new example name"
}
```

#### Постраничная навигация

Некоторые ресурсы `GET` позволяют получать информацию пакетами. Мы предоставим параметры запроса в документации ресурса, когда это применимо.

При запросе нескольких элементов мы устанавливаем значение `limit` по умолчанию на `20` элементов. Вы можете указать другое значение, используя параметр `limit`, когда это необходимо. Максимальное значение для параметра `limit`, которое мы принимаем, равно `100`.

Ниже приведен пример запроса API, который извлекает первые 100 записей, указанных параметрами `limit=100` и `offset=0`.

Чтобы извлечь следующую партию записей, увеличьте параметр смещения на `1`.

```http
GET https://api.iafcertsearch.org/api/client/v1/resource?limit=100&offset=0 HTTP/1.1
```

### Успешные запросы

| **Глагол** | **Возвращаемый объект ресурса**                            |
| ---------- | ---------------------------------------------------------- |
| GET        | Возвращает один объект ресурса или массив объектов ресурса |
| PATCH      | Возвращает обновленный объект ресурса                      |
| PUT        | Возвращает обновленный объект ресурса                      |
| DELETE     | Нет возвращаемого содержимого                              |
| POST       | Возвращает вновь созданный объект ресурса                  |