# Встраивание

Различные методы, которые используют [JSON web tokens](https://jwt.io/introduction/), чтобы получить Карточки или Дашборды.
Такие методы аналогичны `api/public/` и отличаются только тем, как они авторизованы.

Чтобы использовать данные методы:

    1.  Установите настройки ключа `embedding-secret-key` в 32-байтовую последовательность в шестнадцатеричном формате (например, строка из 64 знаков).
        Вы можете использовать `/api/util/random_token` чтобы получить криптобезопасное значение.
    2.  Sign/base-64 кодирует веб-токен JSON с помощью секретного ключа и передает его как соответствующую часть пути URL к различным конечным точкам здесь.
    
    Токены могут иметь следующие поля::
    
      {:resource {:question  <card-id>
                  :dashboard <dashboard-id>}
       :params   <params>}.

## `GET /api/embed/card/:token`

Получить карточку через JSON Web Token подписанный с `embedding-secret-key`.

Токен должен иметь следующий формат:

     {:resource {:question <card-id>}}.

### Параметры:

* **`token`**

## `GET /api/embed/card/:token/field/:field-id/remapping/:remapped-id`

Получить переопределенные значения поля. Это то же самое, что и `GET /api/field/:id/remapping/:remapped-id`, но для использования со встроенной Карточкой.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

* **`remapped-id`** целое число больше нуля.

* **`value`** непустая строка.

## `GET /api/embed/card/:token/field/:field-id/search/:search-field-id`

Искать значения Поля, которое соотносится со встроенной Карточкой.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

* **`search-field-id`** целое число больше нуля.

* **`value`** непустая строка.

* **`limit`** целое число больше нуля или null.

## `GET /api/embed/card/:token/field/:field-id/values`

Получить значения для Поля, которое соотносится со встроенной Карточкой.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

## `GET /api/embed/card/:token/params/:param-key/search/:prefix`

Развернутая версия поиска цепочки фильтров.

### Параметры:

*  **`token`**

*  **`param-key`**

*  **`prefix`**

## `GET /api/embed/card/:token/params/:param-key/values`

Расширенная версия методов api.card

### Параметры:

*  **`token`**

*  **`param-key`**


## `GET /api/embed/card/:token/query`

Получить результаты работающей Карточки используя JSON Web токен, подписанный ключом `embedding-secret-key`.

Токен должен иметь следующий формат:

     {:resource {:question <card-id>}
      :params   <parameters>}.

### Параметры:

* **`token`**

* **`&`**

* **`query-params`**

## `GET /api/embed/card/:token/query/:export-format`

Как `GET /api/embed/card/query`, но возвращает результаты в файле специального формата.

### Параметры:

* **`token`**

* **`export-format`** перечисление `csv`, `api`, `xlsx`, `json`.

* **`query-params`**

*  **`format_rows`** обнуляемое булевое значение.

## `GET /api/embed/dashboard/:token`

Получить Дашборд через JSON Web токен подписанный ключом `embedding-secret-key`.

Токен должен иметь следующий формат:

     {:resource {:dashboard <dashboard-id>}}.

### Параметры:

* **`token`**

## `GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id`

Получить результаты работы Карточки, принадлежащей Дашборду, используя JSON Web токен, подписанный ключом `embedding-secret-key`.

### Параметры:

* **`token`**

* **`dashcard-id`** целое число больше нуля.

* **`card-id`** целое число больше нуля.

* **`&`**

* **`query-params`**

## `GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:export-format`

Получить результаты работающей Карточки, принадлежащей Дашборду, используя JSON Web токен, подписанный ключом `embedding-secret-key`. Возвращает данные в одном из экспортных форматов.

### Параметры:

* **`token`**

* **`export-format`** перечисление `csv`, `api`, `xlsx`, `json`.

* **`dashcard-id`** целое число больше нуля.

* **`card-id`** целое число больше нуля.

* **`query-params`**

## `GET /api/embed/dashboard/:token/field/:field-id/remapping/:remapped-id`

Получить переопределенные значения поля. Это то же самое, что `GET /api/field/:id/remapping/:remapped-id`, но для использования со встроенными Дашбордами.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

* **`remapped-id`** целое число больше нуля.

* **`value`** непустая строка.

## `GET /api/embed/dashboard/:token/field/:field-id/search/:search-field-id`

Ищет значения Поля, которое соотносится с Карточкой встроенного Дашборда.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

* **`search-field-id`** целое число больше нуля.

* **`value`** непустая строка.

* **`limit`** целое число больше нуля или null.

## `GET /api/embed/dashboard/:token/field/:field-id/values`

Получить значение для Поля, которое используется как параметр во встроенном Дашборде.

### Параметры:

* **`token`**

* **`field-id`** целое число больше нуля.

## `GET /api/embed/dashboard/:token/params/:param-key/search/:prefix`

Встроенная версия метода поиска по цепочке фильтров.

### Параметры:

* **`token`**

* **`param-key`**

* **`prefix`**

* **`query-params`**

## `GET /api/embed/dashboard/:token/params/:param-key/values`

Встроенная версия метода поиска значений фильтра.

### Параметры:

* **`token`**

* **`param-key`**

* **`query-params`**

## `GET /api/embed/pivot/card/:token/query`

Получить результаты работающей Карточки используя JSON Web токен, подписанный ключом `embedding-secret-key`.

Токен должен иметь следующий формат:

     {:resource {:question <card-id>}
      :Params   <parameters>}.

### Параметры:

* **`token`**

* **`&`**

* **`query-params`**

## `GET /api/embed/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id`

Получить результаты работающей Карточки, принадлежащей Дашборду, используя JSON Web токен, подписанный ключом `embedding-secret-key`.

### Параметры:

* **`token`**

* **`dashcard-id`** целое число больше нуля.

* **`card-id`** целое число больше нуля.

* **`&`**

* **`query-params`**

---

[<< Назад к разделу API](./api-documentation.md)