Installationsguide för Joomla Custom API-tillägg

Översikt

Ocuco-landskapet Joomla Custom API-tillägg låter dig skapa anpassade API:er för att utöka funktionerna i Joomla CMS (Content Management System). Genom att använda dessa API:er kan du exponera specifika funktioner eller data från din Joomla-webbplats, vilket gör det möjligt för externa program eller tjänster att kommunicera med din Joomla-webbplats. Med hjälp av de anpassade slutpunkter du har utvecklat erbjuder detta plugin en smidig metod för att arbeta med Joomla-databasen, vilket gör att du enkelt kan utföra CRUD (Skapa, Läs, Uppdatera och Ta bort) operationer.

Hämta Plugin Prissättning planer Pröva På

Steg 1: Installation av anpassat API-tillägg

• Ladda ner zip-filen för miniOrange Custom API-tillägg för Joomla från länken ovan.
• Logga in på din Joomla-sajt Administratör konsol.
• Från vänster växlingsmeny, klicka på Systemkrav, då under installera avsnitt klicka på förlängningar.

• Klicka här vidare Bläddra efter fil knappen för att hitta och installera tilläggsfilen som laddades ner tidigare.

• När installationen av plugin har lyckats. Klicka nu på Börja använda Joomla Custom API-plugin.

Steg 2: Skapa anpassade API:er

• FÅ
• POST [PREMIE]
• SÄTTA [PREMIE]
• RADERA [PREMIE]

Varför använda GET API

• Om du vill hämta data eller information från din Joomla-webbplats kan du skapa ett GET API. Du kan lägga till flera filter och villkor till get API:et med hjälp av vårt plugin.
• När du gör en GET-förfrågan till ett API kan du ange parametrar eller frågesträngar i URL:en för att ange de data du vill hämta från din Joomla-webbplats. Joomla Custom API-pluginet bearbetar sedan begäran och returnerar den begärda informationen i svaret.

Konfigurationssteg för att skapa ett anpassat GET API

• Navigera först till Skapa anpassat API fliken.
• Här ser du en färdig att använda DEMO-API som hämtar data från #__kategorier tabellen med en enkel GET-förfrågan. Klicka Testa för att se livesvaret direkt.

• Klicka nu på Skapa anpassat API knapp.

Konfigurera API-detaljer

• Ange API-namn och välj GET-metoden från rullgardinsmenyn.
• Använda parametrar
• Välj API-typ: Efter parametrar.
• Välj nu tabellnamnet som du vill utföra datahämtningen på.
• Det kommer nu att visas flera alternativ för att välja kolumner och filter för detta API. Ange kolumnerna i tabellen från vilka du vill hämta data från Joomla-webbplatsen. Du kan välja flera kolumner här.
• [PREMIE] Välj lämpliga villkor och filter enligt dina behov, eller så kan du välja att inte ha något villkor alls. Klicka på +-knappen om du vill lägga till flera WHERE-villkor för att filtrera bort data. Du kan ta bort villkoret eller filtret genom att klicka på --knappen.
• [PREMIE] Växla på Aktivera autentisering alternativet om du vill aktivera autentisering på API-slutpunkten. (Se steg 3 för att lära dig hur du konfigurerar API-autentisering.)
• Efter att du har konfigurerat API:et, klicka på Spara knappen slutligen för att skapa din anpassade slutpunkt/REST API.

• Använda anpassat SQL API [PREMIE]
• Välj API-typ: Anpassat SQL-API.
• Skriv den anpassade SQL-fråga som du vill köra på det lyckade API-anropet. Till exempel:

SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; att ha _ i parameternamnet är obligatoriskt.



• Klicka på Spara knappen för att skapa det anpassade API:et.

Varför använda POST API

• Om du vill skicka data till din Joomla-webbplats för att skapa resurser på webbplatsen kan du använda POST API:et.
• När du gör en POST-förfrågan till ett API skickar du data i begäran, vanligtvis i JSON- eller formkodat format. Joomla Custom API-pluginet bearbetar sedan informationen och utför nödvändiga åtgärder baserat på informationen i begäran.

Konfigurationssteg för att skapa ett anpassat POST API

• Navigera först till Skapa anpassat API/SQL fliken.
• Klicka på Klicka här knappen för att skapa ett nytt API.

• Ange en API-namn och välj POST API-metoden från rullgardinsmenyn. Klicka sedan på Skapa API knapp.

Konfigurera API-detaljer

• Använda parametrar
• Välj API-typ: Efter parametrar.
• Välj nu tabellnamnet som du vill utföra dataskapandeåtgärden på.
• Nu visas flera alternativ för att välja kolumner. Ange kolumnerna i tabellen från vilka du vill hämta data från Joomla-webbplatsen. Du kan välja flera kolumner här.
• Välj Kroppsdataformat som du vill skicka data till rubriken från rullgardinsmenyn.
• Växla på Aktivera autentisering alternativet om du vill aktivera autentisering på API-slutpunkten. (Se steg 3 för att lära dig hur du konfigurerar API-autentisering.)
• Efter att du har konfigurerat API:et, klicka på Spara knappen slutligen för att skapa din anpassade slutpunkt/REST API.

• Använda anpassat SQL API
• Välj API-typ: Anpassat SQL-API.
• Du kan göra alla parametrar obligatoriska genom att markera kryssrutan. Den här funktionen kräver att alla kundparametrar skickas i ett API-anrop.
• Skriv den anpassade SQL-fråga som du vill köra på det lyckade API-anropet. Till exempel:

INSERT INTO #__users (id, namn, användarnamn, e-post, registerDate, params) VÄRDEN '{{id}}','{{name}}','{{användarnamn}}','{{email}}', '{{registerDate}}','{{params}}';



• Klicka på Spara knappen för att skapa det anpassade API:et.

Varför använda PUT API

• Om du vill uppdatera eller ersätta en befintlig resurs på din Joomla-webbplats kan du skapa ett PUT API.
• När du gör en PUT-förfrågan till ett API skickar du data i parametrar eller frågesträngar eller i begäran för att ersätta hela representationen av resursen som identifieras av begäran-URL:en. Joomla Custom API-pluginet bearbetar sedan informationen och uppdaterar resursen därefter.

Konfigurationssteg för att skapa ett anpassat PUT API

• Navigera först till Skapa anpassat API/SQL fliken.
• Klicka på Klicka här knappen för att skapa ett nytt API.

• Ange en API-namn och välj PUT API-metoden från rullgardinsmenyn. Klicka sedan på Skapa API knapp.

Konfigurera API-detaljer

• Använda parametrar
• Välj API-typ: Efter parametrar.
• Välj nu tabellnamnet som du vill ange ny data på.
• Välj sedan de kolumner som du vill uppdatera med API-anropet.
• Välj lämpliga villkor enligt dina behov eller så kan du välja att inte ha några villkor alls. Klicka på + knappen om du vill lägga till flera WHERE-villkor för att filtrera bort data. Du kan även ta bort villkoret genom att klicka på - knappen.
• Du har flexibiliteten att skicka data antingen som frågeparametrar eller i begäran.
• Se till att du skickar data med formatnyckel=Parameternamn (som nämns i tabellen Begäranformat och tillämpade villkor) och värde=enligt de specifika kraven.
• För att uppdatera användarposten i exemplet ovan måste du följa följande:
• Ange URL:en: '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
• Välj sedan PUT HTTP-metoden.
• Skicka data för namn, användarnamn, param_1, param_2 i begäran (du kan även skicka in frågeformatet).
• Du kommer att få 1 i svaret om data har uppdaterats i tabellen.

• Använda anpassat SQL API
• Välj API-typ: Anpassat SQL-API.
• Skriv den anpassade SQL-fråga som du vill köra på det lyckade API-anropet. Till exempel:

UPPDATERA #__users set username='{{användarnamn}}' där id='{{id}}';



• Klicka på Spara knappen för att skapa det anpassade API:et.

Varför använda DELETE API

• Om du vill ta bort en specifik resurs på din Joomla-webbplats kan du skapa ett DELETE API.
• När du gör en DELETE-begäran till ett API kan du ange parametrar eller frågesträngar i URL:en eller i begäran för att ange de data du vill ta bort från din Joomla-webbplats. Joomla Custom API-pluginet bearbetar sedan informationen och uppdaterar resursen därefter.

Konfigurationssteg för att skapa ett anpassat DELETE API

• Navigera först till Skapa anpassat API/SQL fliken.
• Klicka på Klicka här knappen för att skapa ett nytt API.

• Ange en API-namn och välj DELETE API-metoden från rullgardinsmenyn. Klicka sedan på Skapa API knapp.

Konfigurera API-detaljer

• Använda parametrar
• Välj API-typ: Efter parametrar.
• Välj nu tabellnamnet som du vill utföra databorttagningsåtgärden på.
• Välj lämpliga villkor enligt dina behov eller så kan du välja att inte ha några villkor alls. Klicka på + knappen om du vill lägga till flera WHERE-villkor för att filtrera bort data. Du kan även ta bort villkoret genom att klicka på - knappen.
• Växla på Aktivera autentisering alternativet om du vill aktivera autentisering på API-slutpunkten. (Se steg 3 för att lära dig hur du konfigurerar API-autentisering.)
• Efter att du har konfigurerat API:et, klicka på Spara knappen slutligen för att skapa din anpassade slutpunkt/REST API.

• Använda anpassat SQL API
• Välj API-typ: Anpassat SQL-API.
• Skriv den anpassade SQL-fråga som du vill köra på det lyckade API-anropet. Till exempel:

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



• Klicka på Spara knappen för att skapa det anpassade API:et.

Steg 3: Konfigurera API-autentisering [PREMIE]

• Bärartoken
• JWT-autentisering
• Grundläggande autentisering
• API-nyckel

Autentisering av bärartoken:

En enkel tokenbaserad autentisering där klienter skickar en Bearer-token i Authorization-headern.

• Första växeln på Aktivera autentisering knapp i Konfigurera API-detaljer sektion.
• I Konfigurera autentisering menyn, välj Bärartoken från rullgardinsmenyn.
• Klicka på Generera token knappen för att automatiskt skapa en säker slumpmässig token. Till exempel: 7c4a8d09ca3762af61e59520943dc26494f8941b
• Klicka på "Spara konfiguration" för att tillämpa inställningarna för Bearer-token. Token kommer att lagras säkert i databasen.

API-användning:

• Inkludera token i API-förfrågningar:

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



• Testa Bearer-token med följande cURL-kommandon:

``` bash
curl -X GET "https://dinsajt.com/api/endpoint" \
-H "Auktorisering: Bärare din_token_här" \
-H "Innehållstyp: application/json"

Testa autentisering med Postman:

• Öppna brevbäraren.
• Ange förfrågningsmetod och URL.
• Gå nu till fliken Auktorisering.
• Välj typen "Bearer Token".
• Ange sedan din token i fältet Token.

Grundläggande autentisering (Joomla användarautentisering):

Använder befintliga Joomla-användaruppgifter (användarnamn/lösenord) kodade i Base64 och skickade via Authorization-headern.

• Första växeln på Aktivera autentisering knapp i Konfigurera API-detaljer sektion.
• I Konfigurera autentisering menyn, välj Grundläggande Auth från rullgardinsmenyn.
• Ingen ytterligare konfiguration krävs, men användarna måste finnas i Joomlas användardatabas.
• Slutligen, klicka på Spara konfiguration knapp.

API-användning:

• Inkludera Joomla användarnamn/lösenord i API-förfrågningar:

Rubrik: Auktorisering: Grundläggande base64(användarnamn:lösenord)



• Testa Basic Auth med följande cURL-kommandon:

```bash curl -X GET "https://dinsajt.com/api/endpoint" \
-H "Auktorisering: Grundläggande $(echo -n 'användare:pass' | base64)" \
-H "Innehållstyp: application/json"

Testa autentisering med Postman:

• Öppna brevbäraren.
• Ange förfrågningsmetod och URL.
• Gå nu till fliken Auktorisering.
• Välj typen "Grundläggande autentisering".
• Ange Joomla användarnamn och lösenord.

API-nyckelautentisering (Joomla-användarautentisering):

Headerbaserad autentisering med API-nycklar. Stöder både universella nycklar (enstaka nyckel för alla användare) och användarbaserade nycklar (enskilda nycklar per användare).

• Första växeln på Aktivera autentisering knapp i Konfigurera API-detaljer sektion.
• I Konfigurera autentisering menyn, välj API-nyckel från rullgardinsmenyn.
• Välj nu API-nyckeltyp.
• För universell API-nyckel:
• Välja Universell API-nyckel Radio knapp.
• Klicka på Generera universell API-nyckel knapp.
• En enda API-nyckel genereras för all API-åtkomst. Till exempel: uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• För användarbaserad API-nyckel:
• Välja Användarbaserad API-nyckel Radio knapp.
• Generera nycklar för alla befintliga Joomla-användare: Klicka Generera API-nycklar för alla användareNycklar kommer att skapas för alla aktiva Joomla-användare.
• Generera nyckel för specifik användare: Ange användarnamnet i fältet "Användarnamn". Klicka Generera API-nyckel för användare.
• Klicka Spara konfiguration för att tillämpa API-nyckelinställningar.

API-användning:

• Inkludera API-nyckeln i förfrågningar:

Rubrik: X-API-KEY:



• Testa API-nyckeln med följande cURL-kommandon:

``` bash
curl -X GET "https://dinsajt.com/api/endpoint" \
-H "X-API-KEY: din_api_nyckel_här" \
-H "Innehållstyp: application/json"

Testa autentisering med Postman:

• Öppna brevbäraren.
• Ange förfrågningsmetod och URL.
• Gå nu till fliken Rubriker.
• Lägg till rubrik: Key = "X-API-KEY", Value = "your_api_key".

JWT-autentisering:

JWT-autentisering låter dig autentisera åtkomst till Custom REST API och Joomla standard-API-slutpunkten med hjälp av en giltig JWT-token (JSON Web Token). Plugin-programmet tillhandahåller en slutpunkt för att generera en Bearer JWT med hjälp av den giltiga användarens Joomla-inloggningsuppgifter. Den genererade token kan användas för att autentisera Custom och Joomla REST API-slutpunkter.

• Första växeln på Aktivera autentisering knapp i Konfigurera API-detaljer sektion.
• I Konfigurera autentisering menyn, välj JWT-bärare från rullgardinsmenyn.
• Välj nu API-nyckeltyp.
• Välj Signeringsalgoritm från rullgardinsmenyn.
• För HS256, gå in i hemlig nyckel.
• För RS256, ladda upp Offentliga och privata nycklar.
• Ange utgångstiden (t.ex. 3600 för 1 timme).
• Klicka på Spara knapp.

För att få JWT-token, följ följande steg:

• För att hämta JWT:n måste vi skicka en POST-fråga som innehåller användarens Joomla-inloggningsuppgifter. Användarnamnet och lösenordet måste skickas i ett base64-kodat format. För din bekvämlighet, vänligen se formatet för begäran nedan.

Begäran: POST {joomla_base_url}/api/index.php/v1/mini/id_token
Rubrik:
Auktorisering: Grundläggande base64-kodad
Acceptera: application/json
Exempel på förfrågningsformat för curl-
--plats --begär POST "/api/index.php/v1/mini/id_token' \
--header 'Acceptera: application/json'\
--header 'Content-Type: application/json' \
--header 'Auktorisering: Grundläggande base64-kodad' \'

Steg 4: Autentisering för REST API:er [PREMIE]

Konfigurera autentisering för Joomlas kärn-API:er och API:er som finns på din Joomla-webbplats, vilka automatiskt tillämpas när dessa API:er anropas.

• Gå till REST API-autentisering fliken.
• Ange API-namn och API-slutpunkt i de givna fälten.
• Välj sedan HTTP-metod från rullgardinsmenyn.
• Slå sedan på Aktivera autentisering knappen och välj önskad autentiseringsmetod. Se steg 3 avsnittet i guiden för att se hur du konfigurerar de olika autentiseringsmetoderna.

Steg 5: Konfigurera externa API:er [PREMIE]

• Gå till Externa API:er fliken.
• Ange API-namnet.
• Välj sedan API-metod från rullgardinsmenyn.
• Ange Externt API i det givna fältet.
• Du kan skicka frågeparametrar som är nödvändiga för detta konfigurerade API. För att data ska skickas i frågeparameterformatet.
• Det finns två textfält - det första är för att ange nyckeln och det andra för att ange värdet.
• Till exempel→ Om du måste ange följande frågeparameter 'användarnamn→testuser' måste du ange 'användarnamn' i nyckeln och 'testuser' i valueE-fältet.
• Du kan lägga till flera parametrar med hjälp av + knappen.
• I rubrikerna finns det två textrutor - den vänstra är för rubriknamnet och den högra för rubrikvärdet som behöver skickas. Till exempel: Om rubriken som skickas ska vara i formatet Auktorisering:Bärare kommer 'Auktorisering' att läggas till i den första textrutan och 'Bärare' ska placeras i den högra textrutan som visas i diagrammet nedan.
• Om API-leverantören förväntar sig att informationen behöver skickas i API-slutpunktsbegäran kan du fylla i de obligatoriska uppgifterna. Det finns två format tillgängliga för att skicka informationen: x-www-form-urlencoded och JSON.
• För att data ska skickas i brödtextparametrarna i formatet x-www-form-urlencoded.
• Det finns två textfält - det första är för att ange nyckeln och det andra för att ange värdet.
• Till exempel→ Om du måste ange följande brödparameter 'username→testuser' måste du ange 'username' i nyckeln och 'testuser' i värdefältet.
• För de flera nyckelvärdespar som måste skickas i begäran om API-slutpunktsbegäran kan du klicka på + -knappen.
• För att data ska skickas i body-parametrarna i JSON-format: Du måste välja JSON från rullgardinsmenyn som motsvarar begärandetexten.
• Klicka nu på Spara konfiguration knapp.

Steg 6: Konfigurera Joomla Core REST API:er [PREMIE]

• Navigera till Joomla Core REST API:er fliken och klicka på Konfigurera nytt API knapp.

• För att konfigurera Joomla Core REST API behöver du en API-autentiseringstoken. Gå till Användare -> Hantera -> Klicka på en användare.

• Här gå till Joomla API-token fliken och kopiera token.

• Återgå till Joomla Core REST API fliken och klistra in den genererade token i det angivna fältet. Ange ett namn för den här konfigurationen och välj sedan önskat namn. Slutpunkt från rullgardinsmenyn. Om det behövs kan du också ansöka Frågefilter och konfigurera Slutpunktsfält tillsammans med den föredragna UtdataformatNär allt är klart klickar du på Test-API knappen för att verifiera konfigurationen.

• Du kommer att se en API-svar om konfigurationen lyckades. Klicka sedan på Spara Config knapp.

• Dina Joomla Core REST API har konfigurerats. Du kan nu kopiera den genererade kortkod från det här avsnittet och placera det var som helst på din webbplats för att visa API-svaret direkt på användargränssnittet.

Relaterade artiklar

• Läs mer om vårt anpassade API-tillägg.
• Realtidssynkronisering av data mellan Joomla och en anpassad webbplats.
• Implementering av säker JWT-autentisering för Joomla Core API:er.