Guia de configuração da extensão de API personalizada do Joomla

Visão geral

As Extensão de API personalizada do Joomla Permite criar APIs personalizadas para expandir as funcionalidades do Joomla CMS (Sistema de Gerenciamento de Conteúdo). Ao usar essas APIs, você pode expor características ou dados específicos do seu site Joomla, permitindo que programas ou serviços externos se comuniquem com o seu site Joomla. Com a ajuda dos endpoints personalizados que você desenvolveu, este plugin oferece um método simples para trabalhar com o banco de dados Joomla, permitindo que você execute facilmente CRUD (Criar, Ler, Atualizar e Excluir) operações.

Baixe Plugin Planos de preços Teste Grátis

Etapa 1: Instalação da extensão de API personalizada

• Baixe o arquivo zip para o Extensão de API personalizada miniOrange para Joomla no link acima.
• Faça login no seu site Joomla Administrador console.
• No menu de alternância à esquerda, clique em System, então em Instale seção clique em Extensões.

• Clique aqui em Procure o arquivo botão para localizar e instalar o arquivo de extensão baixado anteriormente.

• Assim que a instalação do plugin for bem-sucedida, clique em Comece a usar o plugin Joomla Custom API.

Etapa 2: Criar APIs personalizadas

• ENTRE
• POST [PRÊMIO]
• PUT [PRÊMIO]
• EXCLUIR [PRÊMIO]

Por que usar a API GET

• Se você deseja recuperar dados ou informações do seu site Joomla, pode criar uma API GET. Você pode adicionar vários filtros e condições à API GET usando nosso plugin.
• Ao fazer uma solicitação GET para uma API, você pode fornecer parâmetros ou strings de consulta na URL para especificar os dados que deseja recuperar do seu site Joomla. O plugin Joomla Custom API processa a solicitação e retorna os dados solicitados na resposta.

Etapas de configuração para criar uma API GET personalizada

• Primeiro navegue até o Criar API personalizada aba.
• Aqui você encontrará um produto pronto para uso. API DEMONSTRATIVA que obtém dados do #__categorias tabela usando uma solicitação GET simples. Clique Testar Para visualizar a resposta ao vivo instantaneamente.

• Agora clique em Criar API personalizada botão.

Configurar detalhes da API

• Introduzir o Nome da API e selecione o Método GET a partir do menu suspenso.
• Usando Parâmetros
• Selecione o tipo de API: Por Parâmetros.
• Agora selecione o nome da tabela na qual você deseja executar a ação de recuperação de dados.
• Agora, serão exibidas várias opções para selecionar colunas e filtros para esta API. Especifique as colunas da tabela das quais você deseja recuperar dados do site Joomla. Você pode selecionar as várias colunas aqui.
• [PRÊMIO] Escolha as condições e filtros adequados às suas necessidades ou opte por não definir nenhuma condição. Clique no botão + se desejar adicionar várias condições WHERE para filtrar os dados. Você também pode remover a condição ou o filtro clicando no botão -.
• [PRÊMIO] Alternar no Ativar autenticação opção caso queira habilitar a autenticação no endpoint da API. (Consulte a Etapa 3 para saber como configurar a autenticação de API.)
• Após configurar a API, clique em Economize botão por fim para criar seu endpoint personalizado/API REST.

• Usando API SQL personalizada [PRÊMIO]
• Selecione o tipo de API: API SQL personalizada.
• Escreva a consulta SQL personalizada que você deseja executar na chamada de API bem-sucedida. Por exemplo:

SELECIONE * DE #__usuários ONDE id='{{id_param}}' E email='{{email_param}}'; ter _ é obrigatório no nome do parâmetro.



• Clique no Economize botão para criar a API personalizada.

Por que usar a API POST

• Se você quiser enviar dados para seu site Joomla para criar recursos no site, você pode usar a API POST.
• Ao fazer uma solicitação POST para uma API, você envia dados no corpo da solicitação, normalmente em formato JSON ou codificado em formulário. O plugin Joomla Custom API processa os dados e executa as ações necessárias com base nas informações fornecidas na solicitação.

Etapas de configuração para criar uma API POST personalizada

• Primeiro navegue até o Criar API/SQL personalizado aba.
• Clique no Clique aqui botão para criar uma nova API.

• Insira um Nome da API e selecione o método POST API no menu suspenso. Em seguida, clique em Criar API botão.

Configurar detalhes da API

• Usando Parâmetros
• Selecione o tipo de API: Por Parâmetros.
• Agora selecione o nome da tabela na qual você deseja executar a ação de criação de dados.
• Agora serão exibidas várias opções para selecionar colunas. Especifique as colunas da tabela das quais você deseja recuperar dados do site Joomla. Você pode selecionar as várias colunas aqui.
• Selecione os Formato de dados corporais no qual você deseja enviar os dados para o cabeçalho a partir do menu suspenso.
• Alternar no Ativar autenticação opção se você quiser habilitar a autenticação no ponto de extremidade da API. (Consulte a Etapa 3 para saber como configurar a autenticação de API.)
• Após configurar a API, clique em Economize botão por fim para criar seu endpoint personalizado/API REST.

• Usando API SQL personalizada
• Selecione o tipo de API: API SQL personalizada.
• Você pode tornar todos os parâmetros obrigatórios marcando a caixa de seleção. Este recurso exige que todos os parâmetros do cliente sejam passados ​​em uma chamada de API.
• Escreva a consulta SQL personalizada que você deseja executar na chamada de API bem-sucedida. Por exemplo:

INSERIR EM #__users (id, nome, nome de usuário, e-mail, data de registro, parâmetros) VALORES '{{id}}','{{nome}}','{{nome de usuário}}','{{e-mail}}','{{data de registro}}','{{parâmetros}}';



• Clique no Economize botão para criar a API personalizada.

Por que usar a API PUT

• Se você quiser atualizar ou substituir um recurso existente no seu site Joomla, você pode criar uma API PUT.
• Ao fazer uma solicitação PUT para uma API, você envia dados em parâmetros, strings de consulta ou no corpo da solicitação para substituir toda a representação do recurso identificado pela URL da solicitação. O plugin Joomla Custom API processa os dados e atualiza o recurso de acordo.

Etapas de configuração para criar uma API PUT personalizada

• Primeiro navegue até o Criar API/SQL personalizado aba.
• Clique no Clique aqui botão para criar uma nova API.

• Insira um Nome da API e selecione o método PUT API no menu suspenso. Em seguida, clique em Criar API botão.

Configurar detalhes da API

• Usando Parâmetros
• Selecione o tipo de API: Por Parâmetros.
• Agora selecione o nome da tabela na qual você deseja inserir novos dados.
• Em seguida, selecione as colunas que você deseja atualizar usando a chamada de API.
• Escolha as condições apropriadas de acordo com suas necessidades ou você também pode optar por não ter nenhuma condição. Clique no botão + se quiser adicionar várias condições WHERE para filtrar os dados. Você também pode remover a condição clicando no botão -.
• Você tem a flexibilidade de passar os dados como parâmetros de consulta ou dentro do corpo da solicitação.
• Certifique-se de passar os dados usando o formato chave=Nome do Parâmetro (mencionado na tabela Formato da Solicitação e Condições Aplicadas) e valor= de acordo com os requisitos específicos.
• Para atualizar a entrada do usuário do exemplo acima, você precisa seguir o seguinte:
• Digite a URL: '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
• Em seguida, selecione o método PUT HTTP.
• Passe dados para nome, nome de usuário, param_1, param_2 no corpo da solicitação (você também pode passar no formato de consulta).
• Você receberá 1 na resposta se os dados forem atualizados com sucesso na tabela.

• Usando API SQL personalizada
• Selecione o tipo de API: API SQL personalizada.
• Escreva a consulta SQL personalizada que você deseja executar na chamada de API bem-sucedida. Por exemplo:

ATUALIZAÇÃO #__users definir nome de usuário='{{username}}' onde id='{{id}}';



• Clique no Economize botão para criar a API personalizada.

Por que usar a API DELETE

• Se você quiser excluir um recurso específico no seu site Joomla, você pode criar uma API DELETE.
• Ao fazer uma solicitação DELETE para uma API, você pode fornecer parâmetros ou strings de consulta na URL ou no corpo da solicitação para especificar os dados que deseja excluir do seu site Joomla. O plugin Joomla Custom API processa os dados e atualiza o recurso de acordo.

Etapas de configuração para criar uma API DELETE personalizada

• Primeiro navegue até o Criar API/SQL personalizado aba.
• Clique no Clique aqui botão para criar uma nova API.

• Insira um Nome da API e selecione o método DELETE API no menu suspenso. Em seguida, clique em Criar API botão.

Configurar detalhes da API

• Usando Parâmetros
• Selecione o tipo de API: Por Parâmetros.
• Agora selecione o nome da tabela na qual você deseja executar a ação de exclusão de dados.
• Escolha as condições apropriadas de acordo com suas necessidades ou você também pode optar por não ter nenhuma condição. Clique no botão + se quiser adicionar várias condições WHERE para filtrar os dados. Você também pode remover a condição clicando no botão -.
• Alternar no Ativar autenticação opção se você quiser habilitar a autenticação no ponto de extremidade da API. (Consulte a Etapa 3 para saber como configurar a autenticação de API.)
• Após configurar a API, clique em Economize botão por fim para criar seu endpoint personalizado/API REST.

• Usando API SQL personalizada
• Selecione o tipo de API: API SQL personalizada.
• Escreva a consulta SQL personalizada que você deseja executar na chamada de API bem-sucedida. Por exemplo:

EXCLUIR DE #__usuários ONDE id='{{id}}';



• Clique no Economize botão para criar a API personalizada.

Etapa 3: Configurar a autenticação da API [PRÊMIO]

• Símbolo do portador
• Autenticação JWT
• Autenticação básica
• Chave API

Autenticação de Token do Portador:

Uma autenticação simples baseada em token, onde os clientes enviam um token Bearer no cabeçalho de autorização.

• Primeiro alterne em Ativar autenticação botão no Configurar detalhes da API seção.
• De acordo com o relatório Configurar autenticação menus, selecione Símbolo do portador no menu suspenso.
• Clique no Gerar token botão para criar automaticamente um token aleatório seguro. Por exemplo: 7c4a8d09ca3762af61e59520943dc26494f8941b
• Clique em "Salvar configuração" para aplicar as configurações do token do portador. O token será armazenado com segurança no banco de dados.

Uso da API:

• Incluir o token nas solicitações de API:

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



• Teste o Bearer Token usando os seguintes comandos cURL:

```bash
curl -X OBTER "https://seusite.com/api/endpoint" \
-H "Autorização: Portador do seu_token_aqui" \
-H "Tipo de conteúdo: aplicativo/json"

Teste a autenticação usando o Postman:

• Abra o carteiro.
• Defina o método de solicitação e a URL.
• Agora, vá para a aba Autorização.
• Selecione o tipo "Token do Portador".
• Em seguida, insira seu token no campo Token.

Autenticação básica (autenticação de usuário do Joomla):

Usa credenciais de usuário existentes do Joomla (nome de usuário/senha) codificadas em Base64 e enviadas via cabeçalho de autorização.

• Primeiro alterne em Ativar autenticação botão no Configurar detalhes da API seção.
• De acordo com o relatório Configurar autenticação menus, selecione Autenticação básica no menu suspenso.
• Nenhuma configuração adicional é necessária, mas os usuários devem existir no banco de dados de usuários do Joomla.
• Por fim, clique em Salvar configuração botão.

Uso da API:

• Incluir nome de usuário/senha do Joomla nas solicitações de API:

Cabeçalho: Autorização: Base64 básica (nome de usuário: senha)



• Teste a autenticação básica usando os seguintes comandos cURL:

```bash curl -X GET "https://seusite.com/api/endpoint" \
-H "Autorização: Básica $(echo -n 'user:pass' | base64)" \
-H "Tipo de conteúdo: aplicativo/json"

Teste a autenticação usando o Postman:

• Abra o carteiro.
• Defina o método de solicitação e a URL.
• Agora, vá para a aba Autorização.
• Selecione o tipo "Autenticação básica".
• Digite o nome de usuário e a senha do Joomla.

Autenticação de chave de API (autenticação de usuário do Joomla):

Autenticação baseada em cabeçalho usando chaves de API. Suporta chaves universais (chave única para todos os usuários) e chaves baseadas em usuário (chaves individuais por usuário).

• Primeiro alterne em Ativar autenticação botão no Configurar detalhes da API seção.
• De acordo com o relatório Configurar autenticação menus, selecione Chave API no menu suspenso.
• Agora escolha o Tipo de chave API.
• Para chave de API universal:
• Selecionar Chave de API universal botao de radio.
• Clique na Gerar chave de API universal botão.
• Uma única chave de API será gerada para todos os acessos à API. Por exemplo: uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• Para chave de API baseada em usuário:
• Selecionar Chave de API baseada no usuário botao de radio.
• Gerar chaves para todos os usuários Joomla existentes: Clique Gerar chaves de API para todos os usuários. Chaves serão criadas para todos os usuários ativos do Joomla.
• Gerar chave para usuário específico: Digite o nome de usuário no campo "Nome de usuário". Clique em Gerar chave de API para usuário.
• Clique Salvar configuração para aplicar configurações de chave de API.

Uso da API:

• Incluir a chave de API nas solicitações:

Cabeçalho: X-API-KEY:



• Teste a chave de API usando os seguintes comandos cURL:

```bash
curl -X OBTER "https://seusite.com/api/endpoint" \
-H "X-API-KEY: sua_chave_de_API_aqui" \
-H "Tipo de conteúdo: aplicativo/json"

Teste a autenticação usando o Postman:

• Abra o carteiro.
• Defina o método de solicitação e a URL.
• Agora, vá para a aba Cabeçalhos.
• Adicionar cabeçalho: Chave = "X-API-KEY", Valor = "your_api_key".

Autenticação JWT:

A autenticação JWT permite autenticar o acesso ao endpoint da API REST personalizada e da API padrão do Joomla usando um token JWT válido (JSON Web Token). O plugin fornece um endpoint para gerar um Bearer JWT usando as credenciais de login válidas do usuário Joomla. O token gerado pode ser usado para autenticar os endpoints da API REST personalizada e do Joomla.

• Primeiro alterne em Ativar autenticação botão no Configurar detalhes da API seção.
• De acordo com o relatório Configurar autenticação menus, selecione Portador JWT no menu suspenso.
• Agora escolha o Tipo de chave API.
• Selecione os Algoritmo de assinatura No menu suspenso.
• Para HS256, introduzir o Chave Secreta.
• Para RS256, carregue o Chaves públicas e privadas.
• Digite o tempo de expiração (por exemplo, 3600 para 1 hora).
• Clique no Economize botão.

Para obter o Token JWT, siga os seguintes passos:

• Para adquirir o JWT, precisamos enviar uma consulta POST contendo as credenciais do Joomla do usuário. O nome de usuário e a senha devem ser enviados em formato base64. Para sua conveniência, consulte o formato da solicitação abaixo.

Solicitação: POST {joomla_base_url}/api/index.php/v1/mini/id_token
Cabeçalho:
Autorização: Base64 codificado básico
Aceitar: application / json
Formato de solicitação de curl de amostra -
--localização --solicitação POST "/api/index.php/v1/mini/id_token' \"
--header 'Aceitar: application/json'\
--header 'Tipo de conteúdo: aplicativo/json' \
--header 'Autorização: Base64encoded básico' \'

Etapa 4: Autenticação para APIs REST [PRÊMIO]

Configure a autenticação para as APIs principais do Joomla e as APIs hospedadas no seu site Joomla que serão aplicadas automaticamente quando essas APIs forem chamadas.

• Vou ao Autenticação REST API aba.
• Introduzir o Nome da API e Ponto final da API nos campos fornecidos.
• Em seguida, selecione o Método HTTP No menu suspenso.
• Em seguida, ative o Ativar autenticação botão e selecione o método de autenticação de sua escolha. Consulte o Etapa 3 seção do guia para ver como configurar os diferentes métodos de autenticação.

Etapa 5: Configurar APIs externas [PRÊMIO]

• Vou ao APIs externas aba.
• Digite o nome da API.
• Em seguida, selecione o Método API da lista suspensa.
• Introduzir o API externa no campo determinado.
• Você pode passar parâmetros de consulta necessários para esta API configurada para que os dados sejam enviados no formato de parâmetros de consulta.
• Existem 2 campos de texto: o primeiro é para inserir a chave e o segundo é para inserir o valor.
• Por exemplo→ Se você tiver que passar o seguinte parâmetro de consulta 'username→testuser', então você precisa colocar 'username' na chave e 'testuser' no campo valuE.
• Você pode adicionar vários parâmetros usando o botão +.
• Nos Cabeçalhos, há duas caixas de texto: a da esquerda é para o nome do cabeçalho e a da direita para o valor do cabeçalho que precisa ser passado. Por exemplo: se o cabeçalho passado estiver no formato Autorização:Portador, a palavra "Autorização" será adicionada na primeira caixa de texto e a palavra "Portador" deverá ser inserida na caixa de texto da direita, conforme mostrado no diagrama abaixo.
• Se o provedor da API espera que os dados sejam enviados no corpo da solicitação de endpoints da API, você pode preencher os detalhes necessários. Há dois formatos disponíveis para enviar os dados: x-www-form-urlencoded e JSON.
• Para que os dados sejam enviados nos parâmetros do corpo no formato x-www-form-urlencoded.
• Existem 2 campos de texto: o primeiro é para inserir a chave e o segundo é para inserir o valor.
• Por exemplo→ Se você tiver que passar o seguinte parâmetro do corpo 'username→testuser', então você precisa colocar 'username' na chave e 'testuser' no campo de valor.
• Para os vários pares de valores-chave que precisam ser passados ​​no corpo da solicitação do ponto de extremidade da API, você pode clicar no botão +.
• Para que os dados sejam enviados nos parâmetros do corpo no formato JSON: Você precisa selecionar o JSON no menu suspenso correspondente ao Corpo da Solicitação
• Agora, clique no botão Salvar configuração botão.

Etapa 6: Configurar as APIs REST do Joomla Core [PRÊMIO]

• Navegue até a APIs REST do núcleo do Joomla guia e clique no Configurar nova API botão.

• Para configurar a API REST do Joomla Core, você precisará de um token de autenticação de API. Acesse Usuários -> Gerenciar -> Clique em um usuário.

• Aqui, acesse o Token da API do Joomla guia e copie o token digital único, .

• Retorne para API REST do Joomla Core Na guia correspondente, cole o token gerado no campo indicado. Insira um nome para esta configuração e, em seguida, escolha a opção desejada. Ponto final a partir do menu suspenso. Se necessário, você também pode aplicar Filtros de consulta e configurar o Campos de ponto final juntamente com o preferido Formato de saídaDepois de tudo configurado, clique em API de teste botão para verificar a configuração.

• Você verá um Resposta da API Se a configuração for bem-sucedida, clique em Salvar configuração botão.

• Sua API REST do Joomla Core A configuração foi concluída com sucesso. Agora você pode copiar o arquivo gerado. shortcode A partir desta seção, insira o código em qualquer lugar do seu site para exibir a resposta da API diretamente no front-end.

Artigos Relacionados

• Saiba mais sobre nossa extensão de API personalizada.
• Sincronização de dados em tempo real entre o Joomla e um site personalizado.
• Implementando autenticação JWT segura para APIs principais do Joomla.