VibeFox Aramex for OpenCart — 도움말

요구 사항

OpenCart: 3.0.x(3.0.5.0에서 테스트됨) 또는 4.0.2 이상(4.1.0.3에서 테스트됨).

PHP: 8.0 이상.

Aramex 계정(실시간 요금에만 필요): 실시간 요금은 Aramex Rate Calculator API를 사용합니다. Aramex는 계정 보유자에게 API 접근 권한을 제공합니다. Aramex 담당 매니저에게 문의하거나 Aramex 웹사이트의 Aramex Developers Solution Center를 참고하십시오. 여섯 가지 값이 필요합니다: API 사용자 이름(보통 이메일 주소), 비밀번호, 계정 번호, 계정 PIN, 계정 엔티티(예: DXB), 계정 국가 코드(예: AE). 국가별 고정 요금만 사용한다면 Aramex 계정은 필요하지 않습니다.

VibeFox 라이선스 키: vibefox.net에서 구입합니다. 키 하나는 도메인 하나에서 작동합니다.

설치

다운로드 파일은 두 OpenCart 버전용 패키지가 들어 있는 하나의 zip 파일입니다. 컴퓨터에서 압축을 푸십시오. 여기에는 README.txt, OpenCart 3용 패키지 vfd_aramex-oc3-(version).ocmod.zip, OpenCart 4용 패키지 vfd_aramex.ocmod.zip이 들어 있습니다. 사용 중인 OpenCart 버전의 패키지만 설치하십시오. 라이선스 키는 두 버전에서 같습니다.

OpenCart 3

1. 관리자 화면에서 Extensions > Installer로 이동하여 Upload를 클릭하고 vfd_aramex-oc3-(version).ocmod.zip 파일을 선택합니다. 이 확장 프로그램은 OCMOD 수정 사항을 추가하지 않으므로 Extensions > Modifications를 새로 고칠 필요가 없습니다. Installer 대신 이 패키지의 upload 폴더 내용을 쇼핑몰의 루트 폴더에 복사할 수도 있습니다.

2. Extensions > Extensions로 이동하여 확장 프로그램 유형으로 Shipping을 선택합니다. VibeFox Aramex를 찾아 Install(녹색 + 버튼)을 클릭합니다.

3. Edit(연필 버튼)을 클릭하여 설정 페이지를 엽니다.

4. Edit 페이지 상단의 라이선스 블록에 있는 License key 입력란에 VibeFox 라이선스 키를 붙여 넣고 Activate를 클릭하십시오(라이선스 키 참조).

5. 배송비 계산 방식을 선택하고 해당 섹션을 작성한 뒤(설정 참조), Enable Aramex를 켜고 Save를 클릭합니다.

OpenCart 4

1. 관리자 화면에서 Extensions > Installer로 이동하여 Upload를 클릭하고 vfd_aramex.ocmod.zip 파일을 선택합니다. 파일 이름을 바꾸지 마십시오. OpenCart 4는 확장 프로그램 코드를 파일 이름에서 가져오므로, 이름을 바꾼 패키지는 작동하지 않습니다.

2. 패키지가 같은 페이지의 설치된 확장 프로그램 목록에 나타납니다. 그 옆의 Install(녹색 + 버튼)을 클릭하십시오.

3. Extensions > Extensions로 이동하여 확장 프로그램 유형으로 Shipping을 선택합니다. VibeFox Aramex를 찾아 Install(녹색 + 버튼)을 클릭한 다음 Edit(연필 버튼)를 클릭하십시오.

4. OpenCart 3의 4~5단계와 같이 라이선스 키와 설정을 입력하십시오. 설정 페이지와 그 항목은 두 버전이 같습니다.

설치 후에는 Enable Aramex를 켜고 저장하기 전까지 이 배송 방법은 꺼져 있습니다. 제거 후 확장 프로그램을 다시 설치하면, 보관해 둔 Aramex 설정이 다시 사용됩니다.

설정

모든 설정은 확장 프로그램 페이지에 있습니다: Extensions > Extensions > Shipping > VibeFox Aramex > Edit. 섹션은 왼쪽에 나열됩니다. 하단의 Save 버튼 하나로 페이지 전체를 새로 고치지 않고 저장합니다. 저장할 때마다 캐시된 Aramex 요금도 지워집니다. 값이 잘못되면 아무것도 저장되지 않으며, 페이지에 이유가 표시됩니다. 예: Enter a method title (1 to 64 characters)., 필드가 숫자여야 한다는 메시지, 또는 The account country code must have 2 letters, e.g. AE. 설정을 저장할 수 있는 사람은 이 확장 프로그램의 수정 권한이 있는 관리자 사용자뿐입니다.

General

설정은 모든 지오존에 적용됩니다. Conditions에서 배송 방법을 지오존과 특정 국가로 제한할 수 있습니다.

Enable Aramex: 체크아웃에서 Aramex를 표시하거나 숨깁니다. 기본값: 꺼짐.

Method title: 장바구니와 체크아웃에서 고객에게 보이는 배송 방법의 이름. 기본값: Aramex. 필수.

Shipping cost: 요금이 계산되는 방식.

실시간 요금이 없는 이유는 디버그 로그에 기록됩니다. 고객에게는 절대 표시되지 않습니다.

Sort order: 체크아웃의 배송 방법 중 Aramex의 위치. 정수입니다.

Aramex API 계정(실시간 요금에만 필요하며, 여섯 개 필드 모두 필수)

Username: Aramex API 사용자 이름. 보통 이메일 주소입니다. 이 값을 지우면 저장된 비밀번호도 지워집니다.

Password: Aramex API 비밀번호. 저장 후 이 필드는 비워지고 Saved — leave empty to keep it.를 표시합니다. 변경하려는 경우에만 새 값을 입력하십시오.

Account number: Aramex 고객 계정 번호. 이 값을 지우면 저장된 PIN도 지워집니다.

Account PIN: Aramex 계정의 PIN. 비밀번호와 마찬가지로 저장 후에는 다시 표시되지 않습니다.

Account entity: 계정의 Aramex 엔티티(사무소) 코드. 예: DXB, AMM 또는 RUH.

Account country code: Aramex 계정의 두 글자 국가 코드. 예: AE.

Aramex 서비스(실시간 요금에 사용)

배송 주소가 발송 국가에 있으면 해당 화물은 Domestic으로 견적됩니다. 그 밖의 모든 화물은 International express로 견적됩니다.

International service: 해외 배송용 Aramex 상품: PPX Priority Parcel Express(기본값), PDX Priority Document Express, PLX Priority Letter Express(0.5kg 미만 서류), DPX Value Express Parcels, EPX Economy Parcel Express, EDX Economy Document Express, GPX Ground Parcel Express 또는 GDX Ground Document Express.

Domestic service: 발송 국가 내 배송용 Aramex 상품: ONP Overnight (Parcel)(기본값), OND Overnight (Document), SMP Same Day (Parcel), SMD Same Day (Document), SDD Same Day Delivery, EMD Early Morning Delivery, PEC Economy Delivery, PEX Road Express 또는 HVY Heavy(20kg 이상).

Payment type: 배송 비용을 Aramex에 지불하는 주체: Prepaid (shipper pays)(기본값), Collect (receiver pays) 또는 Third party. 보통 Prepaid입니다.

API weight unit: Aramex로 보내는 단위: Kilograms (KG)(기본값) 또는 Pounds (LB). 상품 무게는 무게 단위 클래스에서, 치수는 길이 단위 클래스에서 변환됩니다. 청구 무게는 실제 무게와 부피 무게(가로 × 세로 × 높이(cm) / 5000) 중 큰 값입니다. 최소 0.5kg이며, 무게가 없는 상품에도 적용됩니다.

Currency conversion rate: Aramex에는 쇼핑몰의 기본 통화로 견적을 제공하도록 요청합니다. 그럼에도 다른 통화로 응답하면, 요금에 이 숫자를 곱합니다(Aramex 통화 1단위 = 쇼핑몰 기본 통화 X단위). 이런 견적을 거부하려면 비워 두십시오. 그러면 고객이 잘못된 통화로 청구되는 일이 없습니다.

발송지(실시간 요금에 사용)

Origin country: 발송하는 국가. 첫 번째 옵션인 Store country는 쇼핑몰의 국가를 사용합니다.

Origin city: 발송하는 도시. Aramex에서 필수로 요구합니다. OpenCart의 쇼핑몰 주소는 자유 텍스트이므로 도시를 그곳에서 가져오지 않습니다. 여기에 입력하십시오.

Origin state / emirate: 선택 사항.

Origin postcode: 선택 사항.

발송 국가가 쇼핑몰 국가이면, 비어 있는 주/지역은 System > Settings > Store > Local의 쇼핑몰 지역에서 가져옵니다.

고정 요금(Shipping cost가 Fixed prices일 때 사용하며, 실시간 요금의 대체 수단으로도 사용)

Price per country: 쇼핑몰 기본 통화(세금 제외)로 된 국가와 요금의 목록. Add country를 클릭하면 행을 추가하고, × 버튼을 클릭하면 행을 삭제합니다. 자체 행이 없는 모든 국가에 사용할 요금은 * All other countries를 선택하십시오. 요금이 없는 국가(* 행이 없는 경우)는 고정 요금을 받지 못하므로, 해당 국가에서는 배송 방법이 숨겨집니다.

Fixed price applies: Per order(기본값)는 요금을 한 번만 청구합니다. Per item (price × quantity)는 장바구니의 상품 수량을 곱합니다. Aramex 실시간 요금은 항상 화물 단위로 계산됩니다.

Conditions

Minimum weight (kg): 장바구니 무게가 이 값보다 적으면 배송 방법을 숨깁니다. 0은 제한 없음(기본값)을 의미합니다.

Maximum weight (kg): 장바구니 무게가 이 값보다 크면 배송 방법을 숨깁니다. 기본값: 100. 0은 제한 없음을 의미합니다. 필드를 비워 두면 100kg가 사용됩니다.

Minimum order amount: 배송이 필요한 상품의 소계(쿠폰 적용 후, 세금 전)가 이 금액에 도달한 경우에만 배송 방법을 표시합니다. 항상 표시하려면 비워 두십시오.

Free shipping: 아래 금액부터 Aramex 무료 배송을 켭니다.

Free shipping from: 배송이 무료가 되는 기준이 되는, 배송이 필요한 상품의 소계(쿠폰 적용 후, 세금 전). Free shipping이 켜져 있을 때만 사용됩니다.

Tax class: 배송비의 세금 클래스, 또는 No tax(기본값). Aramex 실시간 요금에는 이미 부가가치세가 포함되어 있을 수 있습니다. 이 경우 배송비에 세금이 이중으로 부과되지 않도록 No tax를 선택하십시오.

Geo zone: 이 지오존 내 주소에만 Aramex를 제공합니다. All zones(기본값)는 제한 없음을 의미합니다. 지오존은 System > Localisation > Geo Zones에서 관리합니다.

Countries: 이 배송 국가에만 Aramex를 제공합니다. 모든 국가를 허용하려면 비워 두십시오. 이 제한은 Geo zone과 함께 적용됩니다.

고급

Debug log: 요금 계산과 API 오류를 storage/logs/vfd_armx_debug.log.php에 기록합니다. 이 파일은 웹에서 읽을 수 없습니다. 비밀번호, PIN, 고객 주소는 절대 기록되지 않습니다. 작업이 끝나면 로그를 끄십시오. 파일이 5MB에 도달하면 vfd_armx_debug.old.log.php로 옮겨지고 새 로그가 시작됩니다.

Log: 디버그 로그의 크기와 최근 항목을 표시합니다. Clear log를 클릭하면 로그를 비웁니다.

Remove data on uninstall: 켜져 있으면, 확장 프로그램을 제거할 때 Aramex 설정, 캐시된 요금, 로그가 삭제됩니다. 꺼져 있으면(기본값) 재설치를 위해 유지됩니다.

가져오기 / 내보내기

내보내기: Download JSON을 클릭하면 설정을 JSON 파일로 저장합니다. 비밀번호와 PIN은 내보내지 않습니다.

가져오기: 이전에 내보낸 JSON을 붙여 넣고 Import를 클릭하면 설정이 복원됩니다. 예를 들어 다른 쇼핑몰에서 사용할 수 있습니다. 값은 일반 저장과 같은 방식으로 검사됩니다. 저장된 비밀번호와 PIN은 유지됩니다.

체크아웃에서의 작동 방식

OpenCart가 배송 방법을 표시할 때, 확장 프로그램에 Aramex 요금을 요청합니다. Geo zone이 설정되어 있고 주소가 그 밖에 있으면 Aramex는 제공되지 않습니다. Requires Shipping이 Yes로 설정된 상품만 계산에 포함됩니다. 다른 상품은 무게를 더하지 않으며 주문 금액에도 포함되지 않습니다. 이후 확장 프로그램은 조건을 확인합니다: 허용된 국가, 장바구니 무게, 최소 주문 금액. 주문 금액은 배송이 필요한 상품의 가격으로, 쿠폰 할인 후 세금 전 금액입니다. 기프트 카드, 적립 포인트, 쇼핑몰 적립금은 고려되지 않습니다. 무료 배송이 적용되면 요금은 0이며 Aramex에 요청이 전송되지 않습니다.

고정 요금 모드에서는 요금을 표에서 가져옵니다. 실시간 요금 모드에서는 확장 프로그램이 발송지와 배송지 주소, 청구 무게, 서비스, 쇼핑몰 기본 통화를 Aramex에 보내고 반환된 합계를 사용합니다. 실시간 요금은 배송지 주소에 도시 또는 우편번호가 있을 때만 요청됩니다. 요금은 쇼핑몰 기본 통화로 계산되고 그 통화의 소수점 자릿수에 맞게 반올림되며, 선택한 Tax class의 세금을 포함하여 고객의 통화로 표시됩니다.

각 응답은 1시간 동안 캐시되므로 같은 장바구니가 새 요청을 일으키지 않습니다. 실패한 요청은 10분 동안 캐시되므로, 체크아웃이 새로 고칠 때마다 Aramex를 기다리지 않습니다. API 시간 초과는 10초입니다.

Aramex가 오류, 0 금액, 또는 환율 없이 다른 통화의 견적을 반환하더라도 고객에게는 오류가 보이지 않습니다. 배송 방법이 숨겨지거나, 대체 모드에서는 고정 요금이 사용됩니다. 이유는 디버그 로그에 기록됩니다.

이 확장 프로그램은 요금만 계산합니다. Aramex 배송 건을 생성하거나, 라벨을 출력하거나, 집화를 예약하거나, 소포를 추적하거나, 고객이 Aramex 지점을 선택하게 하지 않습니다. 주문에는 아무것도 추가하지 않습니다. 주문에는 다른 OpenCart 배송 방법과 마찬가지로 배송 방법 이름과 배송비가 표시됩니다. 소포는 항상 한 개의 화물로 Aramex에 전달됩니다.

OpenCart 4에서는 고객이 체크아웃 페이지의 배송 방법 블록에서 Choose를 클릭하고, Shipping method options 창에서 Aramex를 고릅니다. 이 방법은 OpenCart 3과 같은 방식으로 작동합니다.

라이선스 키

이 확장 프로그램은 vibefox.net에서 받은 VibeFox 라이선스 키로 작동합니다. License — VibeFox Aramex 라이선스 블록은 Extensions > Extensions > Shipping > VibeFox Aramex > Edit 페이지에서 설정 위쪽에 있는 첫 번째 블록입니다. 키를 License key에 붙여 넣고 Activate를 클릭하십시오. 그 후 블록에는 마스킹된 키, 상태(예: 라이선스 사용 기한과 도메인)와 함께 다음 버튼이 표시됩니다: 상태를 다시 확인하는 Check now, 다른 키를 입력하는 Change key, 이 쇼핑몰에서 키를 제거하는 Remove key. 그 아래에는 Product: opencart-shipping-aramex 줄과 Manage licenses and domains in your account 링크가 있으며, 이 링크는 vibefox.net 계정을 엽니다. 키는 이 확장 프로그램의 수정 권한이 있는 관리자 사용자만 변경할 수 있습니다. 블록의 텍스트는 관리자 화면 언어를 따릅니다(영어와 러시아어 포함).

키가 승인되지 않으면 블록에 이유가 표시됩니다. 예: Key not found, This key belongs to another product, Domain limit reached 또는 날짜가 붙은 License expired on. 쇼핑몰 주소를 변경한 후나 계정에서 도메인 슬롯을 해제한 후에는 Check now를 클릭하십시오. 라이선스 서버에 연결할 수 없으면 확장 프로그램은 마지막으로 확인된 상태로 계속 작동합니다.

키 하나는 도메인 하나에서 작동합니다: OpenCart 설정의 쇼핑몰 주소입니다. 쇼핑몰에서 키를 제거해도 도메인 슬롯은 해제되지 않습니다. vibefox.net 계정에서 슬롯을 해제하십시오.

활성 키가 없으면 체크아웃에서 고객에게 Aramex 배송 방법이 표시되지 않고 요금도 계산되지 않습니다. 같은 브라우저에서 관리자 화면에 로그인한 관리자 사용자에게는 쇼핑몰에서 배송 방법이 (unlicensed — visible to admins only) 표시와 함께 계속 보이므로, 키를 구매하기 전에 확장 프로그램을 설정하고 테스트할 수 있습니다. OpenCart 4에서는 이 미리보기를 사용할 수 없습니다. 쇼핑몰은 관리자 로그인을 인식하지 못하므로, 활성 키가 없으면 배송 방법이 모든 사람에게 숨겨집니다. Edit 페이지를 한 번 열면 관리자 Dashboard에 알림이 나타납니다. ×로 닫으면 7일 동안 숨겨집니다. 기존 주문은 영향을 받지 않습니다.

라이선스가 만료되어도 확장 프로그램은 계속 작동하지만, 업데이트와 지원을 받으려면 갱신이 필요합니다. 키를 입력한 후 처음 14일 동안은 하루에 한 번, 그 후에는 일주일에 한 번, 관리자 화면의 Dashboard 또는 Edit 페이지를 열 때 상태가 자동으로 다시 확인됩니다. cron 작업은 필요하지 않습니다. 확장 프로그램을 제거하면 라이선스 키와 라이선스 상태는 항상 삭제됩니다.

문제 해결

체크아웃에 Aramex가 나타나지 않음: 라이선스가 활성 상태이고 Enable Aramex가 켜져 있는지 확인하십시오. Geo zone, Countries, 무게 제한, Minimum order amount를 확인하십시오. 고정 요금 모드에서는 해당 국가 또는 * All other countries에 요금이 있는지 확인하십시오. 상품의 Requires Shipping이 Yes로 설정되어 있는지도 확인하십시오.

실시간 요금이 나타나지 않음: Debug log를 켜고 체크아웃을 다시 불러온 뒤, 확장 프로그램 페이지의 Log 필드를 확인하십시오. 이유가 표시됩니다: API 자격 증명 누락, Aramex 오류 코드, 발송지 도시 없음, 배송지 도시 또는 우편번호 없음, 무게 또는 금액 제한, 또는 다른 통화의 견적. Aramex live rates, fixed prices if the API fails를 사용하면 문제를 해결하는 동안에도 고객은 고정 요금을 받습니다.

로그의 ERR75 오류: Aramex가 로그인을 거부했습니다. Aramex 담당 매니저와 함께 사용자 이름, 비밀번호, 계정 번호, PIN, 엔티티, 국가 코드를 확인하십시오.

다른 통화의 견적이 거부됨: Aramex가 쇼핑몰 기본 통화가 아닌 통화로 응답했습니다. Currency conversion rate를 입력하거나, Aramex에 사용 통화로 견적을 제공하도록 요청하십시오.

배송비에 세금이 이중으로 부과됨: Aramex 합계에는 이미 부가가치세가 포함되어 있을 수 있습니다. Tax class를 No tax로 설정하십시오.

변경 후 요금이 오래된 것처럼 보임: 확장 프로그램 페이지에서 Save를 클릭하십시오. 캐시된 Aramex 요금이 지워집니다.

페이지에 "Warning: You do not have permission to modify VibeFox Aramex!"가 표시됨: 관리자 사용자 그룹에 설정 보기 권한만 있을 수 있습니다. System > Users > User Groups에서 해당 그룹에 extension/shipping/vfd_aramex(OpenCart 3) 또는 extension/vfd_aramex/shipping/vfd_aramex(OpenCart 4)의 수정 권한을 부여하십시오.

개발자용: Aramex API 주소는 설정 vfd_armx_api_url(테스트용)로 바꿀 수 있습니다. 설정 페이지에는 이 항목의 입력란이 없습니다.

제거

Extensions > Extensions로 이동하여 유형 Shipping을 선택하고, VibeFox Aramex 옆의 Uninstall(빨간색 − 버튼)을 클릭하십시오. OpenCart는 항상 Enable Aramex, Sort order, Tax class, Geo zone을 초기화합니다. 캐시된 요금은 항상 삭제됩니다. Remove data on uninstall이 켜져 있으면 Aramex 설정과 디버그 로그도 삭제됩니다. 꺼져 있으면 나머지 설정은 유지되며, 확장 프로그램을 다시 설치할 때 다시 사용됩니다. 기존 주문은 배송 방법과 비용을 그대로 유지합니다.

OpenCart 4에서 확장 프로그램의 파일까지 제거하려면, 제거 후 Extensions > Installer로 이동하여 설치된 확장 프로그램 목록에서 VibeFox Aramex 옆의 Uninstall(주황색 − 버튼)을 클릭한 다음, 업로드한 패키지를 제거하려고 Delete(빨간색 휴지통 버튼)를 클릭하십시오.

Aramex는 해당 소유자의 상표입니다. 이 확장 프로그램은 Aramex와 제휴하거나 Aramex의 승인을 받은 것이 아닙니다.