Руководство по настройке пользовательского расширения API для Joomla

Обзор

Расширение Joomla Custom API Позволяет создавать собственные API для расширения возможностей CMS Joomla (системы управления контентом). Используя эти API, вы можете предоставлять доступ к определенным функциям или данным вашего веб-сайта Joomla.Этот плагин позволяет внешним программам или сервисам взаимодействовать с вашим сайтом Joomla. С помощью разработанных вами пользовательских конечных точек он предлагает удобный способ работы с базой данных Joomla, позволяя легко выполнять следующие действия: CRUD (создание, чтение, обновление и удаление) операций.

Скачать плагин Тарифный план Попробуйте!

Шаг 1: Установка пользовательского расширения API

• Скачайте zip-файл для Расширение пользовательского API miniOrange Для Joomla перейдите по ссылке выше.
• Войдите на свой сайт Joomla. Администратора приставка.
• В левом выпадающем меню нажмите на Система, то под Установите разделом нажмите на Расширения.

• Здесь нажмите на Найдите файл кнопка для поиска и установки ранее загруженного файла расширения.

• После успешной установки плагина нажмите на кнопку. Начните использовать плагин Joomla Custom API.

Шаг 2: Создание пользовательских API

• ПОЛУЧИТЬ
• POST [ПРЕМИУМ]
• ПОЛОЖИЛ [ПРЕМИУМ]
• УДАЛИТЬ [ПРЕМИУМ]

Зачем использовать GET API?

• Если вам нужно получить данные или информацию с вашего сайта Joomla, вы можете создать GET API. С помощью нашего плагина вы можете добавить к GET API множество фильтров и условий.
• При отправке GET-запроса к API вы можете указать параметры или строки запроса в URL-адресе, чтобы определить, какие данные вы хотите получить с вашего сайта Joomla. Затем плагин Joomla Custom API обрабатывает запрос и возвращает запрошенные данные в ответе.

Шаги по настройке для создания пользовательского GET API

• Сначала перейдите по ссылке Создать пользовательский API меню.
• Здесь вы увидите готовый к использованию вариант. ДЕМО API который получает данные из #__категории Таблица, созданная с помощью простого GET-запроса. Щелчок Тест чтобы мгновенно увидеть ответ в режиме реального времени.

• Теперь нажмите Создать пользовательский API .

Настройка параметров API

• Введите Имя API И выберите GET метод из выпадающего меню.
• Использование параметров
• Выберите тип API: По параметрам.
• Теперь выберите имя таблицы, для которой вы хотите выполнить операцию извлечения данных.
• Теперь отобразится несколько вариантов выбора столбцов и фильтров для этого API. Пожалуйста, укажите столбцы таблицы, из которой вы хотите получить данные с сайта Joomla. Здесь можно выбрать несколько столбцов.
• [ПРЕМИУМ] Выберите подходящие условия и фильтры в соответствии с вашими требованиями, или же можете обойтись без условий. Нажмите кнопку «+», если хотите добавить несколько условий WHERE для фильтрации данных. Вы также можете удалить условие или фильтр, нажав кнопку «-».
• [ПРЕМИУМ] Переключить на Включить проверку подлинности Это опция, позволяющая включить аутентификацию для конечной точки API. (См. Шаг 3, чтобы узнать, как настроить аутентификацию API.)
• После настройки API нажмите на Сохранено В конце нажмите кнопку для создания собственной конечной точки/REST API.

• Использование пользовательского SQL API [ПРЕМИУМ]
• Выберите тип API: Пользовательский SQL API.
• Напишите пользовательский SQL-запрос, который вы хотите выполнить при успешном вызове API. Например:

SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; наличие символа _ в имени параметра обязательно.



• Нажмите на Сохранено кнопка для создания пользовательского API.

Зачем использовать POST API?

• Если вы хотите отправлять данные на свой сайт Joomla для создания ресурсов на сайте, вы можете использовать API POST.
• При отправке POST-запроса к API вы передаёте данные в теле запроса, как правило, в формате JSON или в формате, закодированном в форме. Затем плагин Joomla Custom API обрабатывает данные и выполняет необходимые действия на основе информации, предоставленной в запросе.

Шаги по настройке для создания пользовательского POST API

• Сначала перейдите по ссылке Создание пользовательского API/SQL меню.
• Нажмите на Кликните сюда кнопка для создания нового API.

• Введите Имя API и выберите метод POST API из выпадающего списка. Затем нажмите Создать API .

Настройка параметров API

• Использование параметров
• Выберите тип API: По параметрам.
• Теперь выберите имя таблицы, для которой вы хотите выполнить создание данных.
• Теперь отобразится несколько вариантов выбора столбцов. Пожалуйста, укажите столбцы таблицы, из которой вы хотите получить данные с сайта Joomla. Здесь можно выбрать несколько столбцов.
• Выберите Формат данных тела в котором вы хотите отправить данные в заголовок из выпадающего списка.
• Переключить на Включить проверку подлинности Это опция, позволяющая включить аутентификацию для конечной точки API. (См. Шаг 3, чтобы узнать, как настроить аутентификацию API.)
• После настройки API нажмите на Сохранено В конце нажмите кнопку для создания собственной конечной точки/REST API.

• Использование пользовательского SQL API
• Выберите тип API: Пользовательский SQL API.
• Вы можете сделать все параметры обязательными, установив флажок. Эта функция требует передачи всех параметров клиента при вызове API.
• Напишите пользовательский SQL-запрос, который вы хотите выполнить при успешном вызове API. Например:

INSERT INTO #__users (id, name, username, email, registerDate, params) VALUES '{{id}}','{{name}}','{{username}}','{{email}}','{{registerDate}}','{{params}}';



• Нажмите на Сохранено кнопка для создания пользовательского API.

Зачем использовать API PUT?

• Если вы хотите обновить или заменить существующий ресурс на вашем сайте Joomla, вы можете создать API-запрос типа PUT.
• При отправке PUT-запроса к API вы передаете данные в параметрах, строках запроса или в теле запроса, чтобы заменить все представление ресурса, указанного в URL-адресе запроса. Затем плагин Joomla Custom API обрабатывает данные и соответствующим образом обновляет ресурс.

Шаги по настройке для создания пользовательского API PUT

• Сначала перейдите по ссылке Создание пользовательского API/SQL меню.
• Нажмите на Кликните сюда кнопка для создания нового API.

• Введите Имя API и выберите метод API PUT из выпадающего списка. Затем нажмите Создать API .

Настройка параметров API

• Использование параметров
• Выберите тип API: По параметрам.
• Теперь выберите название таблицы, в которую вы хотите ввести новые данные.
• Затем выберите столбцы, которые вы хотите обновить, используя вызов API.
• Выберите подходящие условия в соответствии с вашими требованиями или откажитесь от условий. Нажмите кнопку «+», если хотите добавить несколько условий WHERE для фильтрации данных. Вы также можете удалить условие, нажав кнопку «-».
• У вас есть возможность передавать данные либо в качестве параметров запроса, либо в теле запроса.
• Убедитесь, что вы передаете данные в формате key=Parameter Name (указанном в таблице «Формат запроса и применяемые условия») и value=в соответствии с конкретными требованиями.
• Для обновления записи пользователя в приведенном выше примере необходимо выполнить следующие действия:
• Введите URL: '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
• Затем выберите метод HTTP PUT.
• Передайте данные для имени, имени пользователя, параметра param_1, параметра param_2 в теле запроса (можно также передать в формате запроса).
• В ответе вы получите цифру 1, если данные в таблице успешно обновлены.

• Использование пользовательского SQL API
• Выберите тип API: Пользовательский SQL API.
• Напишите пользовательский SQL-запрос, который вы хотите выполнить при успешном вызове API. Например:

ОБНОВЛЕНИЕ #__users set username='{{username}}' where id='{{id}}';



• Нажмите на Сохранено кнопка для создания пользовательского API.

Зачем использовать API DELETE?

• Если вы хотите удалить определенный ресурс на своем сайте Joomla, вы можете создать API для удаления.
• При отправке DELETE-запроса к API вы можете указать параметры или строки запроса в URL-адресе или в теле запроса, чтобы определить данные, которые вы хотите удалить со своего сайта Joomla. Затем плагин Joomla Custom API обрабатывает данные и соответствующим образом обновляет ресурс.

Этапы настройки для создания пользовательского API DELETE

• Сначала перейдите по ссылке Создание пользовательского API/SQL меню.
• Нажмите на Кликните сюда кнопка для создания нового API.

• Введите Имя API и выберите метод API DELETE из выпадающего списка. Затем нажмите Создать API .

Настройка параметров API

• Использование параметров
• Выберите тип API: По параметрам.
• Теперь выберите имя таблицы, в которой вы хотите выполнить удаление данных.
• Выберите подходящие условия в соответствии с вашими требованиями или откажитесь от условий. Нажмите кнопку «+», если хотите добавить несколько условий WHERE для фильтрации данных. Вы также можете удалить условие, нажав кнопку «-».
• Переключить на Включить проверку подлинности Это опция, позволяющая включить аутентификацию для конечной точки API. (См. Шаг 3, чтобы узнать, как настроить аутентификацию API.)
• После настройки API нажмите на Сохранено В конце нажмите кнопку для создания собственной конечной точки/REST API.

• Использование пользовательского SQL API
• Выберите тип API: Пользовательский SQL API.
• Напишите пользовательский SQL-запрос, который вы хотите выполнить при успешном вызове API. Например:

DELETE FROM #__users WHERE id='{{id}}';



• Нажмите на Сохранено кнопка для создания пользовательского API.

Шаг 3: Настройка аутентификации API [ПРЕМИУМ]

• Жетон на предъявителя
• Аутентификация JWT
• Обычная проверка подлинности
• API ключ

Аутентификация с помощью токена Bearer:

Простая аутентификация на основе токенов, при которой клиенты отправляют токен Bearer в заголовке Authorization.

• Первый переключатель на Включить проверку подлинности в Настройка параметров API .
• В Настроить аутентификацию Переход меню, выберите Жетон на предъявителя из выпадающего меню.
• Нажмите на Создать токен Кнопка для автоматического создания безопасного случайного токена. Например: 7c4a8d09ca3762af61e59520943dc26494f8941b
• Нажмите «Сохранить конфигурацию», чтобы применить настройки токена Bearer. Токен будет надежно сохранен в базе данных.

Использование API:

• Включайте токен в API-запросы:

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



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

``` ударить
curl -X GET "https://yoursite.com/api/endpoint" \
-H "Авторизация: Bearer your_token_here" \
-H «Тип контента: приложение/json»

Проверка аутентификации с помощью Postman:

• Откройте Почтальон.
• Укажите метод запроса и URL-адрес.
• Теперь перейдите на вкладку «Авторизация».
• Выберите тип "Токен предъявителя".
• Затем введите свой токен в поле «Токен».

Базовая аутентификация (аутентификация пользователя Joomla):

Использует существующие учетные данные пользователя Joomla (имя пользователя/пароль), закодированные в Base64 и отправляемые через заголовок Authorization.

• Первый переключатель на Включить проверку подлинности в Настройка параметров API .
• В Настроить аутентификацию Переход меню, выберите Базовая аутентификация из выпадающего меню.
• Дополнительная настройка не требуется, но пользователи должны существовать в базе данных пользователей Joomla.
• Наконец, нажмите на Сохранить конфигурацию .

Использование API:

• Включайте имя пользователя и пароль Joomla в запросы к API:

Заголовок: Authorization: Basic base64(username:password)



• Проверьте базовую аутентификацию, используя следующие команды cURL:

```bash curl -X GET "https://yoursite.com/api/endpoint" \
-H "Авторизация: Базовая $(echo -n 'user:pass' | base64)" \
-H «Тип контента: приложение/json»

Проверка аутентификации с помощью Postman:

• Откройте Почтальон.
• Укажите метод запроса и URL-адрес.
• Теперь перейдите на вкладку «Авторизация».
• Выберите тип аутентификации "Базовая аутентификация".
• Введите имя пользователя и пароль Joomla.

Аутентификация по ключу API (аутентификация пользователя Joomla):

Аутентификация на основе заголовков с использованием ключей API. Поддерживает как универсальные ключи (один ключ для всех пользователей), так и ключи на основе пользователей (индивидуальные ключи для каждого пользователя).

• Первый переключатель на Включить проверку подлинности в Настройка параметров API .
• В Настроить аутентификацию Переход меню, выберите API ключ из выпадающего меню.
• Теперь перейдите в Тип ключа API.
• Для универсального ключа API:
• Выбрать Универсальный ключ API переключатель.
• Нажмите Сгенерировать универсальный ключ API .
• Для доступа ко всем API будет сгенерирован единый ключ API. Например: uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• Для API-ключа, привязанного к пользователю:
• Выбрать Ключ API на основе пользователя переключатель.
• Сгенерировать ключи для всех существующих пользователей Joomla: Нажмите Сгенерировать API-ключи для всех пользователейКлючи будут созданы для всех активных пользователей Joomla.
• Сгенерировать ключ для конкретного пользователя: Введите имя пользователя в поле «Имя пользователя». Нажмите кнопку. Сгенерировать ключ API для пользователя.
• Нажмите Сохранить конфигурацию для применения настроек ключа API.

Использование API:

• Включайте ключ API в запросы:

Заголовок: X-API-KEY:



• Проверьте подлинность ключа API, используя следующие команды cURL:

``` ударить
curl -X GET "https://yoursite.com/api/endpoint" \
-H "X-API-KEY: ваш_ключ_API_здесь" \
-H «Тип контента: приложение/json»

Проверка аутентификации с помощью Postman:

• Откройте Почтальон.
• Укажите метод запроса и URL-адрес.
• Теперь перейдите на вкладку «Заголовки».
• Добавить заголовок: Key = "X-API-KEY", Value = "your_api_key".

Аутентификация с помощью JWT:

Аутентификация с помощью JWT позволяет аутентифицировать доступ к пользовательскому REST API и стандартному API Joomla, используя действительный токен JWT (JSON Web Token). Плагин предоставляет конечную точку для генерации Bearer JWT с использованием действительных учетных данных пользователя Joomla. Сгенерированный токен можно использовать для аутентификации в пользовательских и стандартных REST API Joomla.

• Первый переключатель на Включить проверку подлинности в Настройка параметров API .
• В Настроить аутентификацию Переход меню, выберите JWT Bearer из выпадающего меню.
• Теперь перейдите в Тип ключа API.
• Выберите Алгоритм подписания в раскрывающемся меню.
• Для пакетов HS256, введите Secret Key.
• Для пакетов RS256, загрузить Открытый и закрытый ключи.
• Введите время истечения срока действия (например, 3600 означает 1 час).
• Нажмите на Сохранено .

Чтобы получить JWT-токен, выполните следующие шаги:

• Для получения JWT необходимо отправить POST-запрос, содержащий учетные данные пользователя Joomla. Имя пользователя и пароль должны быть отправлены в формате, закодированном в base64. Для вашего удобства, пожалуйста, ознакомьтесь с форматом запроса ниже.

Запрос: POST {joomla_base_url}/api/index.php/v1/mini/id_token
Заголовок:
Авторизация: Базовая кодировка base64
Принять: приложение/json
Пример формата запроса curl.
--location --request POST "/api/index.php/v1/mini/id_token' \"
--header 'Accept: application/json'
--header 'Тип содержимого: application/json' \
--header 'Авторизация: Базовая кодировка base64' \'

Шаг 4: Аутентификация для REST API [ПРЕМИУМ]

Настройте аутентификацию для основных API Joomla и API, размещенных на вашем сайте Joomla, которая будет автоматически применяться при вызове этих API.

• Перейдите на сайт Аутентификация REST API меню.
• Введите Имя API и Конечная точка API в данных полях.
• Затем выберите HTTP-метод в раскрывающемся меню.
• Затем включите Включить проверку подлинности Нажмите кнопку и выберите удобный для вас способ аутентификации. См. также... Шаг 3 В разделе руководства вы найдете информацию о настройке различных методов аутентификации.

Шаг 5: Настройка внешних API [ПРЕМИУМ]

• Перейдите на сайт Внешние API меню.
• Введите имя API.
• Затем выберите Метод API из выпадающего списка.
• Введите Внешний API в данной сфере.
• Вы можете передавать параметры запроса, необходимые для работы с этим настроенным API. Данные должны быть отправлены в формате параметров запроса.
• Имеется два текстовых поля: первое предназначено для ввода ключа, а второе — для ввода значения.
• Например, если вам нужно передать следующий параметр запроса 'username→testuser', то вам необходимо указать 'username' в поле ключа, а 'testuser' в поле значения.
• С помощью кнопки «+» можно добавить несколько параметров.
• В разделе «Заголовки» есть два текстовых поля: левое предназначено для имени заголовка, а правое — для значения заголовка, которое необходимо передать. Например: если заголовок должен быть в формате Authorization:Bearer, то в первое текстовое поле будет добавлено «Authorization», а в правое — «Bearer», как показано на схеме ниже.
• Если поставщик API ожидает, что данные должны быть отправлены в теле запроса к конечной точке API, вы можете указать необходимые данные. Доступны 2 формата для отправки данных: x-www-form-urlencoded и JSON.
• Для отправки данных в теле запроса параметры должны быть в формате x-www-form-urlencoded.
• Имеется два текстовых поля: первое предназначено для ввода ключа, а второе — для ввода значения.
• Например, если вам нужно передать следующий параметр тела запроса: 'username→testuser', то вам необходимо указать 'username' в поле ключа, а 'testuser' в поле значения.
• Для передачи нескольких пар ключ-значение в теле запроса к конечной точке API можно нажать кнопку «+».
• Для отправки данных в формате JSON в качестве параметров тела запроса: необходимо выбрать JSON из выпадающего списка, соответствующего тегу «Тело запроса».
• Теперь нажмите на Сохранить конфигурацию .

Шаг 6: Настройка REST API ядра Joomla [ПРЕМИУМ]

• Перейдите в REST API ядра Joomla и нажмите Настройка нового API .

• Для настройки REST API ядра Joomla вам потребуется токен аутентификации API. Перейдите по ссылке: Пользователи -> Управление -> Щелкните по пользователю.

• Вот иди в Токен API Joomla вкладку и скопируйте знак.

• Вернуться в REST API ядра Joomla Вставьте сгенерированный токен в соответствующее поле. Введите имя для этой конфигурации, затем выберите необходимое. Конечная точка из выпадающего меню. При необходимости вы также можете подать заявку. Фильтры запросов и настроить Поля конечной точки наряду с предпочтительным Формат выводаПосле того, как все будет настроено, нажмите кнопку. Тестовый API кнопка для проверки конфигурации.

• Вы увидите Ответ API Если настройка прошла успешно, нажмите на кнопку. Сохранить конфигурацию .

• Ваша REST API ядра Joomla Настройка выполнена успешно. Теперь вы можете скопировать сгенерированный файл. короткий код Выберите этот элемент из данного раздела и разместите его в любом месте вашего сайта, чтобы отображать ответ API непосредственно на лицевой стороне сайта.

Статьи по теме

• Узнайте больше о нашем расширении для пользовательского API.
• Синхронизация данных в реальном времени между Joomla и пользовательским веб-сайтом.
• Внедрение безопасной JWT-аутентификации для основных API Joomla.