VibeFox SMSA Express for OpenCart — 도움말
요구 사항
OpenCart: 3.0.x(3.0.5.0에서 테스트) 또는 4.0.2 이상(4.1.0.3에서 테스트).
PHP: 8.0 이상.
SMSA Express 요금표: 가격 표의 가격은 SMSA 계정 또는 SMSA 영업팀에서 받습니다. 쇼핑몰의 기본 통화로 입력하십시오. 요금표가 SAR, AED 또는 다른 통화라면 먼저 환산하십시오.
SMSA passKey(실시간 요금에만 해당): 실시간 요금은 SMSA 웹 서비스(SECOM, 작업 getShipCharges)를 사용합니다. SMSA는 요청에 따라 passKey를 발급합니다. SMSA 계정 담당자에게 요청하거나 info@smsaexpress.com으로 문의하십시오. passKey는 SMSA 전자상거래 포털의 API 키와 다를 수 있습니다. 이 서비스에는 SMSA의 테스트(샌드박스) 서버가 없습니다.
VibeFox 라이선스 키: vibefox.net에서 구매합니다. 키 하나는 도메인 하나에서 작동합니다.
설치
다운로드 파일은 두 가지 OpenCart 버전용 패키지가 들어 있는 zip 파일 하나입니다. 컴퓨터에서 압축을 푸십시오. 여기에는 README.txt, OpenCart 3용 패키지 vfd_smsa_express-oc3-(version).ocmod.zip, OpenCart 4용 패키지 vfd_smsa_express.ocmod.zip이 포함됩니다. 사용 중인 OpenCart 버전에 맞는 패키지만 설치하십시오. 라이선스 키는 두 버전에 동일하게 사용됩니다.
OpenCart 3
1. 관리자에서 Extensions > Installer로 이동하여 Upload를 클릭하고 vfd_smsa_express-oc3-(version).ocmod.zip 파일을 선택합니다. 이 확장 기능은 OCMOD 수정 사항을 추가하지 않으므로 Extensions > Modifications를 새로 고칠 필요가 없습니다. Installer 대신 이 패키지의 upload 폴더 내용을 쇼핑몰의 루트 폴더에 복사할 수도 있습니다.
2. Extensions > Extensions로 이동하여 확장 기능 유형으로 Shipping을 선택합니다. VibeFox SMSA Express를 찾아 Install(녹색 + 버튼)을 클릭합니다.
3. Edit(연필 버튼)를 클릭하여 설정 페이지를 엽니다.
4. Edit 페이지 상단의 라이선스 블록에 있는 License key에 VibeFox 라이선스 키를 입력하고 Activate를 클릭합니다(라이선스 키 참조).
5. 가격 표에 SMSA Express 가격을 입력합니다.
6. 선택 사항: Live rates (API)에서 Live charges를 켜고, SMSA passKey, 발송지 도시와 국가를 입력합니다. 쇼핑몰의 기본 통화가 SAR이 아니라면 환율도 입력합니다.
7. Enable SMSA Express를 켜고 Save를 클릭합니다.
OpenCart 4
1. 관리자에서 Extensions > Installer로 이동하여 Upload를 클릭하고 vfd_smsa_express.ocmod.zip 파일을 선택합니다. 파일 이름을 바꾸지 마십시오. OpenCart 4는 파일 이름에서 확장 기능 코드를 가져오므로, 이름을 바꾼 패키지는 작동하지 않습니다.
2. 같은 페이지의 설치된 확장 기능 목록에 패키지가 나타납니다. 그 옆의 Install(녹색 + 버튼)을 클릭하십시오.
3. Extensions > Extensions로 이동하여 확장 기능 유형으로 Shipping을 선택합니다. VibeFox SMSA Express를 찾아 Install(녹색 + 버튼)을 클릭한 다음 Edit(연필 버튼)를 클릭하십시오.
4. 라이선스 키와 설정은 OpenCart 3의 4~7단계와 같이 입력하십시오. 설정 페이지와 그 필드는 두 버전에서 동일합니다.
설치 후에는 Enable SMSA Express를 켜고 저장하기 전까지 이 방법은 비활성 상태입니다. 제거한 뒤 확장 기능을 다시 설치하면, 보관해 둔 SMSA Express 설정이 다시 사용됩니다.
설정
모든 설정은 확장 기능 페이지에 있습니다: Extensions > Extensions > Shipping > VibeFox SMSA Express > Edit. 섹션은 왼쪽에 나열됩니다. Save 버튼 하나로 페이지 전체를 다시 불러오지 않고 저장합니다. 저장할 때마다 캐시된 SMSA 요금도 지워집니다. 잘못된 방법 제목, 숫자가 아닌 값, 음수, 환율 0, 3자리가 아닌 통화 코드, 표의 잘못된 가격, Maximum weight (kg)보다 큰 Minimum weight (kg), 정수가 아닌 정렬 순서는 오류와 함께 거부되며, 수정하기 전까지 아무것도 저장되지 않습니다. 이 확장 기능을 수정할 권한이 있는 관리자 사용자만 설정을 저장할 수 있습니다.
실시간 요금이 켜져 있으면, 설정 위의 경고가 passKey, 발송지 도시 또는 환율이 없거나 가격 표가 비어 있다는 것을 알려 줍니다. 쇼핑몰에 kg 무게 등급이 없고 기본 무게 단위를 확장 기능이 인식하지 못하는 경우에도 경고가 나타납니다(이 경우 상품 무게는 kg으로 읽힙니다). System > Localisation > Weight Classes에서 kg 무게 등급을 추가하십시오.
일반
설정은 모든 지역 구역에 적용됩니다. Conditions에서 지역 구역으로 제한하거나, Ignore shipping zones로 국가 목록에 제한할 수 있습니다.
Enable SMSA Express: 체크아웃에서 SMSA Express를 표시하거나 숨깁니다. 기본값: 꺼짐.
Method title: 고객이 장바구니와 체크아웃에서 보는 배송 방법 이름. 기본값: SMSA Express. 필수 항목이며, 최대 64자이고, 문자 < > ; = # { }는 사용할 수 없습니다.
Sort order: 체크아웃의 배송 방법 중 SMSA Express의 위치. 정수입니다.
실시간 요금(API)(선택 사항; SMSA가 요금을 반환하지 않으면 가격 표를 사용합니다)
Live charges: SMSA Express에서 배송 요금을 가져옵니다. 꺼져 있으면 체크아웃 중에 SMSA로 아무것도 전송되지 않습니다. 기본값: 꺼짐.
SMSA passKey: SMSA 웹 서비스(SECOM)의 키. 저장한 뒤 이 필드는 비워 두며 Saved — leave empty to keep it.를 표시합니다. 변경하려는 경우에만 새 값을 입력하십시오. 삭제하려면 Remove the saved passKey를 선택합니다. 로그에 "Invalid Passkey"가 나타나면 이 서비스가 해당 키를 받아들이지 않는 것입니다. SMSA에 웹 서비스용 passKey를 요청하십시오.
Ship-from city: 소포를 발송하는 도시. SMSA가 쓰는 방식대로 입력합니다(예: Riyadh, Jeddah, Dammam). 실시간 요금에 필요합니다. OpenCart에는 쇼핑몰 도시가 없으므로 쇼핑몰 주소에서 가져오지 않습니다.
Ship-from country: 소포를 발송하는 국가. 첫 번째 옵션인 Store country는 System > Settings > Store > Local에 있는 쇼핑몰의 국가를 사용합니다. 기본값입니다.
Shipment type: SMSA에 배송 유형으로 전송됩니다. DLV(기본값)는 일반 배송입니다. SMSA가 다른 코드를 알려 준 경우에만 변경하십시오.
Currency of SMSA charges: SMSA가 요금을 반환하는 통화의 3자리 코드. 보통 SAR(기본값)입니다. 이 통화나 쇼핑몰의 기본 통화가 아닌 통화로 된 요금은 사용되지 않습니다.
Exchange rate: SMSA 통화 1단위의 쇼핑몰 기본 통화 가격(예: 0.27). 두 통화가 같으면 필요하지 않습니다. 설정하지 않으면 다른 통화의 요금은 사용되지 않고 가격 표가 적용됩니다.
가격(쇼핑몰의 기본 통화로 된 SMSA Express 요금표입니다. 실시간 요금이 꺼져 있을 때 사용되며, SMSA가 요금을 반환하지 않을 때 대체로도 사용됩니다)
Price table: 목적지 국가마다 한 행입니다. Add country를 클릭하면 행을 추가합니다. * All other countries 행은 자체 행이 없는 국가에 적용됩니다. 각 행에는 Base 요금과 무게 열이 있습니다: XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg, XL >5 kg. 무게 열이 비어 있거나 0이면 기본 요금을 사용합니다. 기본 요금이 0이면 무료 배송을 의미합니다. 요금이 하나도 없는 행은 저장되지 않습니다. 한 국가에 행이 두 개 있으면 첫 번째 행을 사용합니다. "9.99"와 "9,99" 모두 허용됩니다.
Price for countries not in the table: 표에 목적지 국가의 행이 없거나(* 행도 없음) 행에 이 무게의 요금이 없을 때 사용됩니다. 이 경우 방법을 숨기려면 비워 두십시오.
Price applies: 요금을 계산하는 방식.
상품 무게는 OpenCart 무게 등급에서 킬로그램으로 환산됩니다.
조건
Minimum weight (kg): 장바구니가 이보다 가벼우면 이 방법을 숨깁니다. 0은 제한 없음(기본값)을 의미합니다.
Maximum weight (kg): 장바구니가 이보다 무거우면 이 방법을 숨깁니다. 기본값: 30. 0 또는 빈 필드는 제한 없음을 의미합니다.
Minimum order amount: 배송이 필요한 상품의 소계(쿠폰 적용 후, 세금 전)가 이 금액에 도달했을 때만 이 방법을 표시합니다. 항상 표시하려면 비워 두십시오.
Free shipping from: 배송이 필요한 상품의 소계(쿠폰 적용 후, 세금 전)가 이 금액 이상이면 SMSA Express 배송이 무료입니다. 장바구니가 이 금액에 도달하면 요금은 0이 되며 SMSA에 요청이 전송되지 않습니다. 무료 배송을 제공하지 않으려면 비워 두십시오.
Tax class: 배송비의 세금 등급 또는 No tax(기본값). 가격(표와 SMSA 요금)에 이미 세금(예: 사우디 부가가치세)이 포함되어 있으면 No tax를 선택하십시오.
Geo zone: 이 지역 구역 내 주소에만 SMSA Express를 제공합니다. All zones(기본값)는 제한 없음을 의미합니다. Ignore shipping zones가 켜져 있는 동안에는 확인하지 않습니다. 지역 구역은 System > Localisation > Geo Zones에서 관리합니다.
배송 지역 없이 제공 여부
보통 이 방법은 Conditions에서 선택한 지역 구역의 주소에 제공됩니다.
Ignore shipping zones: 지역 구역과 관계없이 아래의 국가에 SMSA Express를 제공합니다. 꺼져 있으면 지역 구역이 결정하며 국가 목록은 사용되지 않습니다.
Countries: 이 모드의 배송 대상 국가. 비워 두면 쇼핑몰에서 활성화된 모든 국가를 사용합니다. 이 필드는 Ignore shipping zones가 켜져 있을 때만 사용됩니다.
고급
Debug log: 요금 계산을 storage/logs/vfd_smsa_debug.log.php에 기록합니다. 이 파일은 웹에서 읽을 수 없습니다. 고객 주소와 키는 기록되지 않습니다. 실시간 요금 오류는 이 옵션이 꺼져 있어도 항상 기록됩니다. 작업이 끝나면 로그를 끄십시오. 파일이 5 MB에 도달하면 vfd_smsa_debug.old.log.php로 옮겨지고 새 로그가 시작됩니다.
Log: 디버그 로그의 크기와 최신 항목을 보여 줍니다. Clear log를 클릭하면 비워집니다.
Remove data on uninstall: 켜져 있으면 확장 기능을 제거할 때 SMSA Express 설정과 디버그 로그가 삭제됩니다. 꺼져 있으면(기본값) 다시 설치할 수 있도록 설정이 유지됩니다. 캐시된 요금은 항상 삭제됩니다.
가져오기 / 내보내기
Export: Download JSON을 클릭하면 설정을 JSON 파일로 저장합니다. passKey는 내보내지 않습니다.
Import: 이전에 내보낸 JSON을 붙여 넣고 Import를 클릭하면 설정을 복원합니다(예: 다른 쇼핑몰에서). 값은 일반 저장과 같은 방식으로 확인됩니다. 저장된 passKey는 유지됩니다.
체크아웃에서의 작동 방식
OpenCart가 배송 방법을 표시할 때, 확장 기능에 SMSA Express 가격을 요청합니다. Geo zone이 설정되어 있고(Ignore shipping zones는 꺼져 있음) 주소가 그 범위 밖이면 SMSA Express는 제공되지 않습니다. Requires Shipping이 Yes로 설정된 상품만 계산에 포함됩니다. 그 밖의 상품은 무게를 더하지 않으며 주문 금액에도 포함되지 않습니다. 그런 다음 확장 기능은 조건을 확인합니다. Ignore shipping zones의 국가(켜져 있는 경우), 장바구니 무게, 최소 주문 금액입니다. 기프트 카드, 포인트, 쇼핑몰 적립금은 고려되지 않습니다. 무료 배송이 적용되면 가격은 0이며 SMSA에 요청이 전송되지 않습니다.
실시간 요금이 켜져 있으면, 확장 기능은 SMSA에 발송지 도시와 국가, 고객의 도시와 국가, 배송 유형, kg 단위 소포 무게, 0원의 착불 결제 금액을 보냅니다. SMSA는 요금과 그 통화를 응답합니다. 확장 기능은 이를 쇼핑몰의 기본 통화로 환산하고 소수점 자리에 맞게 반올림합니다. 그런 다음 가격은 선택한 Tax class의 세금을 포함하여 고객의 통화로 표시됩니다. 실시간 요금은 고객이 도시를 포함한 배송 주소를 입력한 후에만 요청됩니다.
각 요금은 1시간 동안 캐시되므로 같은 장바구니에 대해 새 요청이 생기지 않습니다. 실패한 요청은 5분 동안 캐시됩니다. 시간 초과나 서버 오류 후에는 2분 동안 SMSA에 다시 요청하지 않습니다. 키가 거부된 후에는 5분 동안 요청하지 않습니다. 따라서 체크아웃은 새로 고침할 때마다 실패하는 서비스를 기다리지 않습니다. 요청 제한 시간은 12초입니다.
SMSA가 사용 가능한 요금을 반환하지 않으면(passKey 없음, 도시 미입력, 잘못된 키, 시간 초과, 오류, 해당 도시 서비스 없음, 알 수 없는 통화 등), 가격 표를 사용합니다. 표와 Price for countries not in the table에서도 가격을 찾을 수 없으면 이 방법은 숨겨집니다. 고객은 오류를 절대 보지 않습니다. 이유는 로그에 기록됩니다.
이 확장 기능은 배송 가격만 계산합니다. SMSA 배송을 생성하거나, AWB 라벨을 인쇄하거나, 반품을 처리하거나, 소포를 추적하지 않습니다. 착불 결제와 그 수수료는 실시간 요금에 포함되지 않습니다. SMSA 취급점 선택 기능은 없습니다. 이 방법은 문 앞 배송입니다. 주문에 아무것도 추가하지 않습니다. 주문에는 다른 OpenCart 배송 방법과 마찬가지로 방법 제목과 배송비가 표시됩니다.
OpenCart 4에서는 고객이 체크아웃 페이지의 배송 방법 블록에서 Choose를 클릭한 다음 Shipping method options 창에서 SMSA Express를 선택합니다. 이 방법은 OpenCart 3과 같은 방식으로 작동합니다.
라이선스 키
이 확장 기능은 vibefox.net에서 받은 VibeFox 라이선스 키로 작동합니다. License — VibeFox SMSA Express 라이선스 블록은 Extensions > Extensions > Shipping > VibeFox SMSA Express > Edit 페이지에서 설정 위에 있는 첫 번째 블록입니다. 키를 License key에 붙여 넣고 Activate를 클릭하십시오. 그 후 블록에는 마스킹된 키, 상태(예: 라이선스가 유효한 날짜와 도메인)와 다음 버튼이 표시됩니다: 상태를 다시 확인하는 Check now, 다른 키를 입력하는 Change key, 이 쇼핑몰에서 키를 제거하는 Remove key. 그 아래에는 Product: opencart-shipping-smsa-express 줄과 vibefox.net 계정을 여는 링크 Manage licenses and domains in your account가 있습니다. 키는 이 확장 기능에 대한 Modify 권한이 있는 관리자 사용자만 변경할 수 있습니다. 블록의 문구는 관리자 언어를 따릅니다(영어와 러시아어 포함).
키가 승인되지 않으면 블록에 이유가 표시됩니다. 예: Key not found, This key belongs to another product, Domain limit reached, 또는 날짜가 붙은 License expired on. 쇼핑몰 주소를 변경한 후, 또는 계정에서 도메인 슬롯을 해제한 후에는 Check now를 클릭하십시오. 라이선스 서버에 연결할 수 없으면 확장 기능은 마지막으로 확인된 상태로 계속 작동합니다.
키 하나는 도메인 하나에서 작동합니다. OpenCart 설정의 쇼핑몰 주소입니다. 쇼핑몰에서 키를 제거해도 도메인 슬롯은 해제되지 않습니다. vibefox.net 계정에서 슬롯을 해제하십시오.
활성 키가 없으면 체크아웃에서 고객에게 SMSA Express가 표시되지 않으며 요금도 계산되지 않습니다. 같은 브라우저에서 관리자에 로그인한 관리자 사용자에게는 (unlicensed — visible to admins only) 표시와 함께 쇼핑몰에 이 방법이 계속 나타나므로, 키를 구매하기 전에 확장 기능을 설정하고 테스트할 수 있습니다. OpenCart 4에서는 이 미리 보기를 사용할 수 없습니다. 쇼핑몰은 관리자 로그인을 볼 수 없으므로, 활성 키가 없으면 모든 사용자에게 이 방법이 숨겨집니다. Edit 페이지를 한 번 열면 관리자 Dashboard에 알림이 나타납니다. ×로 닫으면 7일 동안 숨겨집니다. 기존 주문은 영향을 받지 않습니다.
라이선스가 만료되어도 확장 기능은 계속 작동하지만, 업데이트와 지원에는 갱신이 필요합니다. 관리자 Dashboard 또는 Edit 페이지를 열면 상태가 자동으로 다시 확인됩니다. 키를 입력한 후 처음 14일 동안은 하루에 한 번, 그 후에는 일주일에 한 번 확인합니다. cron 작업은 필요하지 않습니다. 확장 기능을 제거하면 라이선스 키와 라이선스 상태는 항상 삭제됩니다.
문제 해결
체크아웃에 SMSA Express가 나타나지 않음: 라이선스가 활성 상태인지, Enable SMSA Express가 켜져 있는지 확인하십시오. Geo zone(또는 Ignore shipping zones가 켜져 있으면 Countries), 무게 제한, Minimum order amount를 확인하십시오. 국가 또는 *에 요금이 있는지, 또는 Price for countries not in the table이 설정되어 있는지 확인하십시오. 상품의 Requires Shipping이 Yes로 설정되어 있는지 확인하십시오.
고객이 SMSA 요금 대신 표의 가격을 봄: SMSA에는 고객의 도시가 필요하므로, 입력되기 전까지는 표의 가격이 표시됩니다. 표는 SMSA가 응답하지 않거나, 키나 도시를 거부하거나, 환율이 없는 통화로 요금을 반환할 때도 사용됩니다. 이유는 확장 기능 페이지의 Log 필드에서 확인하십시오.
로그에 "Invalid Passkey": 해당 키를 SMSA 웹 서비스가 받아들이지 않습니다. SMSA에 웹 서비스용 passKey를 요청하십시오.
고객의 도시가 허용되지 않음: SMSA는 자체 도시 표기를 요구합니다. 배송 주소의 도시와 Ship-from city를 확인하십시오.
설정이 저장되지 않고 오류가 표시됨: 숫자 필드에 텍스트나 음수가 있거나, 환율이 0이거나, 통화 코드가 3자리가 아니거나, Minimum weight (kg)가 Maximum weight (kg)보다 큽니다. 메시지에 표시된 값을 수정하고 Save를 다시 클릭하십시오.
배송비에 세금이 두 번 부과됨: 요금표나 SMSA 요금에 이미 부가가치세가 포함되어 있을 수 있습니다. Tax class를 No tax로 설정하십시오.
변경 후 요금이 오래된 것처럼 보임: 확장 기능 페이지에서 Save를 클릭하십시오. 캐시된 SMSA 요금이 지워집니다.
페이지에 "Warning: You do not have permission to modify VibeFox SMSA Express!"가 표시됨: 관리자 사용자 그룹이 설정을 보기만 할 수 있습니다. System > Users > User Groups에서 해당 그룹에 extension/shipping/vfd_smsa_express(OpenCart 3) 또는 extension/vfd_smsa_express/shipping/vfd_smsa_express(OpenCart 4)에 대한 수정 권한을 부여하십시오.
개발자용: SMSA 웹 서비스 주소는 vfd_smsa_api_url 설정(테스트용)으로 바꿀 수 있습니다. 설정 페이지에는 이 항목의 필드가 없습니다.
제거
Extensions > Extensions로 이동하여 Shipping 유형을 선택하고, VibeFox SMSA Express 옆의 Uninstall(빨간색 − 버튼)을 클릭하십시오. 이 확장 기능의 라이선스 키와 라이선스 상태는 항상 삭제됩니다. OpenCart는 항상 Enable SMSA Express, Sort order, Tax class, Geo zone을 초기화합니다. 캐시된 요금은 항상 삭제됩니다. Remove data on uninstall이 켜져 있으면 SMSA Express 설정과 디버그 로그도 삭제됩니다. 꺼져 있으면 다른 설정은 유지되고, 확장 기능을 다시 설치할 때 다시 사용됩니다. 기존 주문은 배송 방법과 비용을 그대로 유지합니다.
OpenCart 4에서 확장 기능의 파일도 제거하려면, 제거 후 Extensions > Installer로 이동하여 설치된 확장 기능 목록에서 VibeFox SMSA Express 옆의 Uninstall(주황색 − 버튼)을 클릭한 다음, Delete(빨간색 휴지통 버튼)를 클릭하여 업로드한 패키지를 삭제하십시오.
SMSA Express는 해당 소유자의 상표입니다. 이 확장 기능은 SMSA Express와 제휴하거나 SMSA Express의 승인을 받지 않았습니다.
