Перейти к основному содержимому

Идентификаторы API 1.6.0

Карты, коды идентификаторов и генерация новых идентификаторов.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.6.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/identifier/generate
GET/identifier/{code}
GET/identifiers
GET/identifiers/count
GET/identifiers/ext_privileges
GET/identifiers/search
GET/identifiers/sort
POST/identifiers
PUT/identifiers/{code}
DELETE/identifiers/{code}

GET /identifier/generate​

Раздел: Идентификаторы.

Возвращает сгенерированный код выбранного формата идентификотора.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifier/generate" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifier/generate" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifier/generate"
  }
}

GET /identifier/{code}​

Раздел: Идентификаторы.

Возвращает параметры конкретного идентификатора по номеру.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifier/{code}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifier/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifier/{code}"
  }
}

GET /identifiers​

Раздел: Идентификаторы.

Возвращает постраничный список добавленных в систему идентификаторов и их параметры.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifiers"
  }
}

GET /identifiers/count​

Раздел: Идентификаторы.

Возвращает количество добавленных в систему идентификаторов.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifiers/count" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifiers/count" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "count": 12
}

GET /identifiers/ext_privileges​

Раздел: Идентификаторы.

Возвращает список дополнительных привилегий.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifiers/ext_privileges" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifiers/ext_privileges" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifiers/ext_privileges"
  }
}

Раздел: Идентификаторы.

Возвращает постраничный список найденных идентификаторов по параметру запроса.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifiers/search" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifiers/search" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifiers/search"
  }
}

GET /identifiers/sort​

Раздел: Идентификаторы.

Возвращает список идентификаторов, отсортированных по столбцу.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/identifiers/sort" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/identifiers/sort" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/identifiers/sort"
  }
}

POST /identifiers​

Раздел: Идентификаторы.

Добавляет новый идентификатор в систему.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "code": "<card_code>",
  "type": "card",
  "active": true
}'

Пример тела запроса​

{
  "code": "<card_code>",
  "type": "card",
  "active": true
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /identifiers/{code}​

Раздел: Идентификаторы.

Позволяет отредактировать параметры конкретного идентификатора по номеру.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "code": "<card_code>",
  "type": "card",
  "active": true
}'

Пример тела запроса​

{
  "code": "<card_code>",
  "type": "card",
  "active": true
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /identifiers/{code}​

Раздел: Идентификаторы.

Позволяет удалить существующую идентификатор по номеру.

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

curl -k -X DELETE "https://{IP_контроллера}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}