검색 결과 :

×
회원가입 문의하기

목차

Joomla 사용자 정의 API 확장 프로그램 설정 가이드

The Joomla 사용자 지정 API 확장 이 기능을 사용하면 Joomla CMS(콘텐츠 관리 시스템)의 기능을 확장하는 사용자 지정 API를 만들 수 있습니다. 이러한 API를 사용하면 다음과 같은 작업을 수행할 수 있습니다. Joomla 웹사이트의 특정 기능이나 데이터를 노출합니다.외부 프로그램이나 서비스가 Joomla 웹사이트와 통신할 수 있도록 합니다. 사용자가 개발한 사용자 지정 엔드포인트를 통해 이 플러그인은 Joomla 데이터베이스 작업을 원활하게 수행할 수 있도록 지원하여 작업을 쉽게 수행할 수 있도록 합니다. CRUD(생성, 읽기, 업데이트, 삭제) 작업.

플러그인 다운로드 버튼 플러그인 다운로드 플러그인 가격 버튼 플러그인 가격 버튼 가격 책정 계획 무료 평가판 플러그인 무료 평가판 플러그인 무료 시험판

  • zip 파일을 다운로드하세요. miniOrange 사용자 정의 API 확장 위의 링크에서 Joomla를 다운로드하세요.
  • Joomla 사이트에 로그인하세요. 관리자 콘솔.
  • 왼쪽 토글 메뉴에서 시스템, 그 다음에 설치 섹션을 클릭하십시오. 확장.
줌라 대시보드
  • 여기를 클릭하십시오 파일 찾아보기 버튼을 눌러 이전에 다운로드한 확장 파일을 찾아 설치하세요.
Joomla 확장
  • 플러그인 설치가 성공하면. 이제 다음을 클릭하세요. Joomla Custom API 플러그인 사용 시작.
Joomla 확장 프로그램 설치됨


참고 : 이 가이드에는 Joomla Custom API 확장 프로그램의 무료 버전과 프리미엄 버전 모두에 대한 설정 단계가 포함되어 있습니다. 무료 버전에서 사용 가능한 기능은 무료 버전 인터페이스를 사용하여 설명하고, 프리미엄 버전에서만 사용 가능한 기능은 해당 프리미엄 버전에 맞춰 설명합니다. 무료 버전과 프리미엄 버전의 사용자 인터페이스에 약간의 차이가 있을 수 있지만, 전체적인 설정 과정은 동일합니다.

  • POST [프리미엄]

GET API를 사용하는 이유

  • Joomla 사이트에서 데이터나 정보를 검색하려면 GET API를 생성하세요. 플러그인을 사용하여 GET API에 여러 필터와 조건을 추가할 수 있습니다.
  • API에 GET 요청을 할 때 URL에 매개변수나 쿼리 문자열을 제공하여 Joomla 사이트에서 가져올 데이터를 지정할 수 있습니다. 그러면 Joomla Custom API 플러그인이 요청을 처리하고 요청된 데이터를 응답으로 반환합니다.

사용자 정의 GET API를 생성하기 위한 구성 단계

  • 먼저 다음으로 이동하세요 맞춤형 API 생성 탭.
  • 여기에서 바로 사용할 수 있는 것을 보실 수 있습니다. 데모 API 다음에서 데이터를 가져옵니다. #__카테고리 간단한 GET 요청을 사용하여 테이블을 가져옵니다. 클릭하세요. Test 실시간 응답을 즉시 확인하려면.
Joomla 사용자 정의 API 탭 만들기

  • 이제 클릭하십시오. 맞춤형 API 생성 버튼을 클릭합니다.

API 세부 정보 구성

  • 입력 API 이름 선택하고 GET 방법 드롭다운 메뉴에서 선택하세요.
  • 매개변수 사용
    • API 유형을 선택하세요: 매개변수별.
    • 이제 데이터 검색 작업을 수행하려는 테이블 이름을 선택하세요.
    • 이제 이 API에 대한 열과 필터를 선택하는 여러 옵션이 표시됩니다. Joomla 사이트에서 데이터를 검색할 테이블의 열을 지정하세요. 여기에서 여러 열을 선택할 수 있습니다.
    • [프리미엄] 필요에 따라 적절한 조건과 필터를 선택하거나, 조건을 지정하지 않을 수도 있습니다. 여러 개의 WHERE 조건을 추가하여 데이터를 필터링하려면 + 버튼을 클릭하세요. - 버튼을 클릭하면 조건이나 필터를 제거할 수 있습니다.
    • [프리미엄] 토글 인증 사용 API 엔드포인트에서 인증을 활성화하려면 이 옵션을 선택하십시오. (API 인증을 설정하는 방법을 알아보려면 3단계를 참조하세요.)
    • API를 구성한 후 다음을 클릭하세요. 찜하기 마지막 버튼을 눌러 사용자 지정 엔드포인트/REST API를 만듭니다.
Joomla 사용자 정의 API - API 세부 정보 구성

  • 사용자 정의 SQL API 사용 [프리미엄]
    • API 유형을 선택하세요: 사용자 정의 SQL API.
    • 성공적인 API 호출 시 실행할 사용자 지정 SQL 쿼리를 작성하세요. 예:

      • SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; 매개변수 이름에 _가 반드시 포함되어야 합니다.


    • 온 클릭 찜하기 사용자 정의 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API - 사용자 정의 SQL API 구성

POST API를 사용하는 이유

  • 사이트에 리소스를 생성하기 위해 Joomla 사이트로 데이터를 보내려면 POST API를 사용하면 됩니다.
  • API에 POST 요청을 할 때는 일반적으로 JSON 또는 폼 인코딩 형식으로 요청 본문에 데이터를 포함합니다. 그러면 Joomla Custom API 플러그인이 데이터를 처리하고 요청에 제공된 정보를 기반으로 필요한 작업을 수행합니다.

사용자 정의 POST API를 생성하기 위한 구성 단계

  • 먼저 다음으로 이동하세요 사용자 정의 API/SQL 만들기 탭.
  • 온 클릭 Click Here 새로운 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API 탭 만들기
  • ~을 입력하십시오. API 이름 드롭다운에서 POST API 메서드를 선택하세요. 그런 다음 API 생성 버튼을 클릭합니다.
Joomla 사용자 정의 API - POST API 메서드 선택

API 세부 정보 구성

  • 매개변수 사용
    • API 유형을 선택하세요: 매개변수별.
    • 이제 데이터 생성 작업을 수행할 테이블 이름을 선택합니다.
    • 이제 열을 선택할 수 있는 여러 옵션이 표시됩니다. Joomla 사이트에서 데이터를 가져올 테이블의 열을 지정하세요. 여기에서 여러 열을 선택할 수 있습니다.
    • 선택 본문 데이터 형식 드롭다운에서 헤더로 데이터를 보내려는 경우.
    • 토글 인증 사용 API 엔드포인트에서 인증을 활성화하려면 옵션을 선택하세요. (API 인증을 설정하는 방법을 알아보려면 3단계를 참조하세요.)
    • API를 구성한 후 다음을 클릭하세요. 찜하기 마지막 버튼을 눌러 사용자 지정 엔드포인트/REST API를 만듭니다.
Joomla 사용자 정의 API - API 세부 정보 구성

  • 사용자 정의 SQL API 사용
    • API 유형을 선택하세요: 사용자 정의 SQL API.
    • 확인란을 활성화하면 모든 매개변수를 필수로 설정할 수 있습니다. 이 기능을 사용하려면 모든 고객 매개변수가 API 호출 시 전달되어야 합니다.
    • 성공적인 API 호출 시 실행할 사용자 지정 SQL 쿼리를 작성하세요. 예:

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


    • 온 클릭 찜하기 사용자 정의 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API - 사용자 정의 SQL API 구성

PUT API를 사용하는 이유

  • Joomla 사이트의 기존 리소스를 업데이트하거나 교체하려면 PUT API를 만들 수 있습니다.
  • API에 PUT 요청을 하면 요청 URL로 식별된 리소스의 전체 표현을 대체하기 위해 매개변수, 쿼리 문자열 또는 요청 본문에 데이터를 전송합니다. 그러면 Joomla Custom API 플러그인이 데이터를 처리하고 그에 따라 리소스를 업데이트합니다.

사용자 정의 PUT API를 생성하기 위한 구성 단계

  • 먼저 다음으로 이동하세요 사용자 정의 API/SQL 만들기 탭.
  • 온 클릭 Click Here 새로운 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API 탭 만들기
  • ~을 입력하십시오. API 이름 드롭다운에서 PUT API 메서드를 선택하세요. 그런 다음 API 생성 버튼을 클릭합니다.
Joomla 사용자 정의 API - PUT API 메서드 선택

API 세부 정보 구성

  • 매개변수 사용
    • API 유형을 선택하세요: 매개변수별.
    • 이제 새 데이터를 입력하려는 테이블 이름을 선택하십시오.
    • 그런 다음 API 호출을 사용하여 업데이트하려는 열을 선택합니다.
    • 요구 사항에 따라 적절한 조건을 선택하거나 조건을 설정하지 않을 수도 있습니다. 여러 개의 WHERE 조건을 추가하여 데이터를 필터링하려면 + 버튼을 클릭하세요. - 버튼을 클릭하여 조건을 제거할 수도 있습니다.
    • 쿼리 매개변수나 요청 본문에 데이터를 전달하는 유연성이 있습니다.
    • 요청 형식 및 적용되는 조건 표에 언급된 형식 키=매개변수 이름 및 특정 요구 사항에 따른 값=을 사용하여 데이터를 전달해야 합니다.
    • 위 예의 사용자 항목을 업데이트하려면 다음을 따라야 합니다.
      • URL을 입력하세요: '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
      • 그런 다음 PUT HTTP 메서드를 선택합니다.
      • 요청 본문에 이름, 사용자 이름, param_1, param_2에 대한 데이터를 전달합니다(쿼리 형식으로도 전달할 수 있습니다).
      • 테이블에서 데이터가 성공적으로 업데이트되면 응답으로 1을 받게 됩니다.
Joomla 사용자 정의 API - API 세부 정보 구성

  • 사용자 정의 SQL API 사용
    • API 유형을 선택하세요: 사용자 정의 SQL API.
    • 성공적인 API 호출 시 실행할 사용자 지정 SQL 쿼리를 작성하세요. 예:

      • 업데이트 #__users set username='{{username}}' 여기서 id='{{id}}';


    • 온 클릭 찜하기 사용자 정의 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API - 사용자 정의 SQL API 구성

DELETE API를 사용하는 이유

  • Joomla 사이트에서 특정 리소스를 삭제하려면 DELETE API를 만들면 됩니다.
  • API에 DELETE 요청을 할 때, URL이나 요청 본문에 매개변수나 쿼리 문자열을 제공하여 Joomla 사이트에서 삭제할 데이터를 지정할 수 있습니다. 그러면 Joomla Custom API 플러그인이 데이터를 처리하고 그에 따라 리소스를 업데이트합니다.

사용자 정의 DELETE API를 생성하기 위한 구성 단계

  • 먼저 다음으로 이동하세요 사용자 정의 API/SQL 만들기 탭.
  • 온 클릭 Click Here 새로운 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API 탭 만들기
  • ~을 입력하십시오. API 이름 드롭다운에서 DELETE API 메서드를 선택하세요. 그런 다음 API 생성 버튼을 클릭합니다.
Joomla 사용자 정의 API - PUT API 메서드 선택

API 세부 정보 구성

  • 매개변수 사용
    • API 유형을 선택하세요: 매개변수별.
    • 이제 데이터 삭제 작업을 수행할 테이블 이름을 선택합니다.
    • 요구 사항에 따라 적절한 조건을 선택하거나 조건을 설정하지 않을 수도 있습니다. 여러 개의 WHERE 조건을 추가하여 데이터를 필터링하려면 + 버튼을 클릭하세요. - 버튼을 클릭하여 조건을 제거할 수도 있습니다.
    • 토글 인증 사용 API 엔드포인트에서 인증을 활성화하려면 옵션을 선택하세요. (API 인증을 설정하는 방법을 알아보려면 3단계를 참조하세요.)
    • API를 구성한 후 다음을 클릭하세요. 찜하기 마지막 버튼을 눌러 사용자 지정 엔드포인트/REST API를 만듭니다.
Joomla 사용자 정의 API - API 세부 정보 구성

  • 사용자 정의 SQL API 사용
    • API 유형을 선택하세요: 사용자 정의 SQL API.
    • 성공적인 API 호출 시 실행할 사용자 지정 SQL 쿼리를 작성하세요. 예:

      • id='{{id}}'인 #__users에서 삭제;


    • 온 클릭 찜하기 사용자 정의 API를 생성하려면 버튼을 클릭하세요.
Joomla 사용자 정의 API - 사용자 정의 SQL API 구성

베어러 토큰 인증:

클라이언트가 Authorization 헤더에 Bearer 토큰을 보내는 간단한 토큰 기반 인증입니다.

  • 첫 번째 토글을 켜세요 인증 사용 버튼의 API 세부 정보 구성 안내
  • . 인증 구성 메뉴 선택 무기명 토큰 드롭다운 메뉴에서.
  • 온 클릭 토큰 생성 안전한 무작위 토큰을 자동으로 생성하는 버튼입니다. 예: 7c4a8d09ca3762af61e59520943dc26494f8941b
  • "구성 저장"을 클릭하여 Bearer 토큰 설정을 적용하세요. 토큰은 데이터베이스에 안전하게 저장됩니다.
베어러 토큰 인증

API 사용법:

  • API 요청에 토큰을 포함합니다.

    • Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b


  • 다음 cURL 명령을 사용하여 Bearer 토큰을 테스트하세요.

    • ```배쉬
    curl -X GET "https://yoursite.com/api/endpoint" \
    -H "권한 부여: 소지자 your_token_here" \
    -H "콘텐츠 유형: 애플리케이션/json"


Postman을 사용하여 인증 테스트:

  • 포스트맨을 엽니다.
  • 요청 방법과 URL을 설정합니다.
  • 이제 권한 탭으로 이동하세요.
  • "Bearer Token" 유형을 선택하세요.
  • 그런 다음 토큰 필드에 토큰을 입력하세요.

기본 인증(Joomla 사용자 인증):

Base64로 인코딩된 기존 Joomla 사용자 자격 증명(사용자 이름/비밀번호)을 사용하고 Authorization 헤더를 통해 전송합니다.

  • 첫 번째 토글을 켜세요 인증 사용 버튼의 API 세부 정보 구성 안내
  • . 인증 구성 메뉴 선택 기본 인증 드롭다운 메뉴에서.
  • 추가 구성은 필요하지 않지만, 사용자는 Joomla 사용자 데이터베이스에 있어야 합니다.
  • 마지막으로 클릭하세요 구성 저장 버튼을 클릭합니다.
기본 인증

API 사용법:

  • API 요청에 Joomla 사용자 이름/비밀번호를 포함합니다.

    • 헤더: 권한: 기본 base64(사용자 이름: 비밀번호)


  • 다음 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 사용법:

  • 요청에 API 키를 포함합니다.

    • 헤더: X-API-KEY:


  • 다음 cURL 명령을 사용하여 API 키를 테스트하세요.

    • ```배쉬
    curl -X GET "https://yoursite.com/api/endpoint" \
    -H "X-API-KEY: 여기에 당신의_api_키" \
    -H "콘텐츠 유형: 애플리케이션/json"


Postman을 사용하여 인증 테스트:

  • 포스트맨을 엽니다.
  • 요청 방법과 URL을 설정합니다.
  • 이제 헤더 탭으로 이동하세요.
  • 헤더 추가: 키 = "X-API-KEY", 값 = "your_api_key".

JWT 인증:

JWT 인증을 사용하면 유효한 JWT 토큰(JSON 웹 토큰)을 사용하여 사용자 지정 REST API 및 Joomla 기본 API 엔드포인트 액세스를 인증할 수 있습니다. 이 플러그인은 유효한 사용자의 Joomla 로그인 자격 증명을 사용하여 Bearer JWT를 생성하는 엔드포인트를 제공합니다. 생성된 토큰은 사용자 지정 및 Joomla REST API 엔드포인트를 인증하는 데 사용할 수 있습니다.

  • 첫 번째 토글을 켜세요 인증 사용 버튼의 API 세부 정보 구성 안내
  • . 인증 구성 메뉴 선택 JWT 전달자 드롭다운 메뉴에서.
  • 이제 API 키 유형.
  • 선택 서명 알고리즘 드롭 다운 메뉴에서
  • 럭셔리 HS256, 들어가다 비밀 키.
  • 럭셔리 RS256, 업로드 공개 키와 개인 키.
  • 만료 시간을 입력하세요(예: 3600시간의 경우 1).
  • 온 클릭 찜하기 버튼을 클릭합니다.
API 키 인증

JWT 토큰을 받으려면 다음 단계를 따르세요.

  • JWT를 얻으려면 사용자의 Joomla 자격 증명이 포함된 POST 쿼리를 제출해야 합니다. 사용자 이름과 비밀번호는 base64로 인코딩된 형식으로 전송해야 합니다. 편의를 위해 아래 요청 형식을 참조하세요.

    • 요청: POST {joomla_base_url}/api/index.php/v1/mini/id_token
    머리글:
    권한: 기본 base64 인코딩
    수락: application/json
    샘플 curl 요청 형식-
    --위치 --요청 POST "/api/index.php/v1/mini/id_token' \"
    --헤더 '수락: application/json'\
    --header '콘텐츠 유형: application/json' \
    --header '인증: 기본 base64 인코딩' \'


Joomla의 핵심 API와 Joomla 사이트에서 호스팅되는 API에 대한 인증을 구성하면 이러한 API가 호출될 때 자동으로 적용됩니다.

  • 로 이동 REST API 인증 탭.
  • 입력 API 이름 API 엔드포인트 주어진 분야에서.
  • 그런 다음 HTTP 메소드 드롭 다운 메뉴에서
  • 그런 다음 토글을 켜십시오. 인증 사용 버튼을 클릭하고 원하는 인증 방법을 선택하세요. 3단계 가이드의 섹션에서 다양한 인증 방법을 구성하는 방법을 확인하세요.
REST API 인증

  • 로 이동 외부 API 탭.
  • API 이름을 입력하세요.
  • 그런 다음 API 방식 드롭 다운에서
  • 입력 외부 API 주어진 분야에서.
  • 구성된 API에 필요한 쿼리 매개변수를 전달할 수 있습니다. 쿼리 매개변수 형식으로 데이터를 전송합니다.
  • 텍스트 필드는 2개 있습니다. 첫 번째는 키를 입력하는 것이고 두 번째는 값을 입력하는 것입니다.
  • 예를 들어→ 'username→testuser'라는 쿼리 매개변수를 전달해야 하는 경우 'username'을 키에 넣고 'testuser'를 값 필드에 넣어야 합니다.
  • + 버튼을 사용하여 여러 개의 매개변수를 추가할 수 있습니다.
  • 헤더에는 두 개의 텍스트 상자가 있습니다. 왼쪽은 헤더 이름을 위한 것이고 오른쪽은 전달해야 할 헤더 값을 위한 것입니다. 예를 들어, 전달된 헤더가 Authorization:Bearer 형식인 경우, 아래 그림과 같이 첫 번째 텍스트 상자에 'Authorization'이 추가되고 오른쪽 텍스트 상자에 'Bearer'가 입력됩니다.
  • API 제공자가 API 엔드포인트 요청 본문에 데이터를 포함해야 한다고 예상하는 경우, 필요한 정보를 입력할 수 있습니다. 데이터 전송에는 x-www-form-urlencoded와 JSON, 두 가지 형식이 있습니다.
  • x-www-form-urlencoded 형식으로 본문 매개변수로 데이터를 전송합니다.
  • 텍스트 필드는 2개 있습니다. 첫 번째는 키를 입력하는 것이고 두 번째는 값을 입력하는 것입니다.
  • 예를 들어→ 다음 본문 매개변수 'username→testuser'를 전달해야 하는 경우 키 필드에 'username'을, 값 필드에 'testuser'를 입력해야 합니다.
  • API 엔드포인트 요청의 요청 본문에 전달해야 하는 여러 개의 키 값 쌍의 경우 + 버튼을 클릭하면 됩니다.
  • JSON 형식의 본문 매개변수로 데이터를 전송하려면 요청 본문에 해당하는 드롭다운에서 JSON을 선택해야 합니다.
  • 이제 구성 저장 버튼을 클릭합니다.
외부 API 구성

  • 로 이동 Joomla 코어 REST API 탭을 클릭하고 새 API 구성 버튼을 클릭합니다.
외부 API 구성

외부 API 구성

  • Joomla Core REST API를 구성하려면 API 인증 토큰이 필요합니다. 다음 링크로 이동하세요. 사용자 -> 관리 -> 사용자 클릭.
외부 API 구성

  • 여기로 가세요 줌라 API 토큰 탭을 누르고 복사하세요. 토큰.
외부 API 구성

  • 다시 Joomla 코어 REST API 탭을 누르고 생성된 토큰을 지정된 필드에 붙여넣으세요. 이 구성의 이름을 입력한 다음 필수 항목을 선택하세요. 종점 드롭다운 메뉴에서 선택하세요. 필요한 경우 적용할 수도 있습니다. 쿼리 필터 및 구성 엔드포인트 필드 선호하는 것과 함께 출력 형식모든 설정이 완료되면 클릭하세요. 테스트 API 설정을 확인하려면 버튼을 클릭하십시오.
외부 API 구성

  • 당신은 볼 것입니다 API 응답 설정이 성공적으로 완료되면 다음을 클릭하십시오. 구성 저장 버튼을 클릭합니다.
외부 API 구성

  • 너의 Joomla 코어 REST API 설정이 성공적으로 완료되었습니다. 이제 생성된 파일을 복사할 수 있습니다. 단축 코드 이 섹션에서 코드를 가져와 사이트의 원하는 위치에 배치하면 API 응답을 프런트엔드에 직접 표시할 수 있습니다.
외부 API 구성


ADFS_sso ×
안녕하세요!

도움이 필요하다? 우리는 바로 여기에 있습니다!

SUPPORT