VibeFox Correios for PrestaShop — 도움말

요구 사항

PrestaShop: 8.0~9.x.

PHP: 8.0 이상. 모듈은 이전 PHP 버전에서는 설치되지 않습니다.

Correios 계약(실시간 요금에만 해당): 실시간 요금은 Correios Web Services(CWS) 가격 API를 사용하며, posting card가 있는 Correios 계약의 자격 증명이 필요합니다. 세 가지 값이 필요합니다. Meu Correios 사용자(보통 계약의 CNPJ 또는 CPF), API 액세스 코드, posting card 번호입니다. 액세스 코드는 Correios Web Services 포털(cws.correios.com.br, 테스트용은 cwshom.correios.com.br)에서 생성하십시오. 발송지 CEP도 필요합니다. 자격 증명이 없으면 모듈은 고정 요금으로만 작동합니다.

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

설치

1. 백오피스에서 Modules > Module Manager로 이동한 후 Upload a module을 클릭합니다. 모듈의 ZIP 파일을 선택합니다.

2. 업로드가 끝나면 Configure를 클릭하거나, 나중에 모듈 목록에서 VibeFox Correios를 찾아 Configure를 클릭합니다.

3. Configure 페이지 상단의 라이선스 블록에 있는 License key에 VibeFox 라이선스 키를 입력하고 Activate를 클릭합니다(라이선스 키 참조).

4. Correios API 사용자, 액세스 코드, posting card 번호, 발송지 CEP 및 서비스를 입력합니다. 쇼핑몰의 기본 통화가 BRL이 아니면 BRL 환율을 입력합니다. 다른 국가와 대체 요금용 고정 요금을 입력한 후(설정 참조) Save를 클릭합니다.

설치 시 모듈은 배송 기간 텍스트 Correios (Brazilian Post)가 설정된 Correios 운송업체를 생성합니다. 이 운송업체는 모든 지역과 모든 고객 그룹에 할당됩니다. 지역, 고객 그룹, 배송 기간, 로고 및 크기 제한은 Shipping > Carriers에서 변경할 수 있습니다. 그곳에서는 요금을 설정하지 마십시오. 요금은 항상 모듈에서 가져옵니다.

설정

모든 설정은 모듈 페이지에 있습니다. Modules > Module Manager > VibeFox Correios > Configure입니다. 각 섹션에는 전체 페이지를 저장하는 자체 Save 버튼이 있습니다. 저장할 때마다 캐시된 Correios 요금과 API 토큰도 지워집니다. 숫자는 소수점 또는 쉼표로 입력할 수 있습니다.

실시간 요금이나 운송업체가 작동할 수 없는 경우 페이지에 경고가 표시됩니다. 세 가지 자격 증명 중 일부만 입력된 경우, 발송지 CEP가 없는 경우, 다른 통화를 사용하는 쇼핑몰에 BRL 환율이 없는 경우, 또는 자격 증명과 고정 요금이 모두 없는 경우입니다. 각 경고에는 그동안 고정 요금이 사용되는지, 아니면 운송업체가 숨겨지는지가 표시됩니다. 쇼핑몰의 무게 또는 치수 단위를 모듈이 인식하지 못하는 경우에도 경고가 표시됩니다(이 경우 kg 또는 cm로 읽힙니다). 그때는 International > Localization(Local units)에서 kg, g, lb 또는 oz와 cm, mm, m 또는 in을 설정하십시오.

메서드 제목이 비어 있거나 잘못된 경우(최대 64자), Country prices의 숫자 필드나 요금이 0 이상의 숫자가 아닌 경우, BRL 환율이 0인 경우, Min cart weight가 Max cart weight보다 큰 경우, 발송지 CEP가 8자리가 아닌 경우, 또는 다른 서비스 코드가 5자리를 초과하는 경우에는 저장이 메시지와 함께 거부됩니다. 값을 수정하기 전까지 아무것도 저장되지 않습니다.

일반

Enable Correios: 모든 지역에서 운송업체를 한 번에 켜거나 끕니다. 이는 Shipping > Carriers의 운송업체 상태와 같은 스위치입니다.

Method title: 장바구니와 체크아웃에 표시되는 운송업체 이름입니다. 기본값: Correios. 필수 항목입니다.

Tax: 배송비에 추가되는 세금 규칙 또는 No tax(기본값).

Correios API(브라질의 실시간 요금)

브라질 주소의 요금은 Correios 가격 API에서 가져옵니다. API가 요금을 반환하지 않으면(API 중단, CEP 서비스 불가, 소포가 너무 큼), Country prices의 고정 요금이 사용되고, 고정 요금이 없으면 운송업체가 숨겨집니다. 오류 세부 정보는 고객이 아니라 로그에 기록됩니다.

API user: Meu Correios 포털 로그인 정보입니다. 보통 계약의 CNPJ 또는 CPF입니다.

Access code: Correios Web Services 포털에서 생성된 API 액세스 코드(código de acesso)입니다. 포털 비밀번호가 아닙니다. 저장 후 이 필드는 비어 있고 Saved — leave empty to keep it (empty the API user as well to remove it)가 표시됩니다. 변경하려는 경우에만 새 값을 입력하십시오. 저장된 코드를 제거하려면 API user와 Access code를 모두 비우고 저장합니다.

Posting card: 계약의 posting card(cartão de postagem) 번호입니다. 10자리이며, 보통 두 개의 0으로 시작합니다(예: 0012345678). 더 짧은 번호는 앞에 0을 채워 입력됩니다. 번호는 Correios 웹사이트의 Correios Fácil 페이지에서 확인할 수 있습니다.

Homologation: Correios의 테스트(homologation) 환경을 사용합니다. 요청은 homologation 액세스 코드와 함께 apihom.correios.com.br로 전송됩니다. 실제 운영 쇼핑몰에서는 끄십시오.

Origin CEP: 소포를 발송하는 CEP(8자리)입니다. 예: 01001-000.

Service: 체크아웃에서 요금이 책정되는 Correios 서비스입니다. 소매 코드: PAC(04510, 기본값), SEDEX(04014), SEDEX 12(04782), SEDEX 10(04790), SEDEX Hoje(04804). 계약 코드: PAC(03298), SEDEX(03220), SEDEX 12(03140), SEDEX 10(03158), SEDEX Hoje(03204), Correios Mini Envios(04227). 계약 코드에는 해당 서비스가 포함된 계약의 posting card가 필요합니다.

Other service code: 선택 사항입니다. 목록에 없는, 계약의 5자리 서비스 코드입니다(예: 03085). 더 짧은 코드는 앞에 0을 채워 입력됩니다. 입력되면 Service 대신 사용됩니다.

Package format: Correios로 보내는 물품 유형입니다.

Default product weight: kg 단위이며, 무게가 없는 각 상품에 대해 Correios로 전송됩니다. 기본값: 0.3. 상품 무게와 치수는 쇼핑몰 단위에서 변환되며(필드 설명에 표시됨), 장바구니는 하나의 소포로 요금이 계산됩니다.

BRL → store currency rate: 필드 이름에 쇼핑몰의 기본 통화가 표시됩니다. 예: BRL → EUR rate. Correios 요금은 BRL로 표시됩니다. 기본 통화가 BRL이 아니면 1 BRL이 귀하의 통화로 몇 단위인지 입력하십시오. 예: 0.17. 이 값이 없으면 실시간 요금은 사용되지 않습니다. 환율은 0보다 커야 합니다. 기본 통화가 BRL이면 비워 두십시오.

고정 요금(브라질 이외 국가, API 자격 증명이 없는 경우, 그리고 API가 요금을 반환하지 않을 때의 대체 요금으로 사용됩니다)

Country prices: 국가 표이며, 쇼핑몰의 기본 통화로 세금을 제외한 Base 요금과 장바구니 무게별 요금을 포함합니다. XS는 1 kg까지, S는 1~2 kg, M은 2~3 kg, L은 3~5 kg, XL은 5 kg 초과입니다. 크기별 요금이 비어 있거나 0이면 Base 요금이 사용됩니다. Add country를 클릭하면 행이 추가되고, ×를 클릭하면 행이 제거됩니다. * Default (all other countries) 행은 자체 행이 없는 모든 국가의 요금을 설정합니다. 행이 없는 국가(그리고 *에도 해당하지 않는 국가)는 고정 요금을 받지 않습니다. 요금이 하나도 없는 행은 저장되지 않습니다. 숫자가 아니거나 음수인 요금은 오류와 함께 저장을 중단시킵니다. 기본 요금이 0이면 해당 국가는 무료 배송입니다.

Fixed price per: Order는 요금을 한 번만 청구합니다. Item (price × quantity)는 요금에 장바구니의 상품 개수를 곱합니다. 이는 고정 요금에만 적용됩니다. 실시간 요금은 항상 소포 전체에 대해 계산됩니다.

조건

Min cart weight: kg 단위입니다. 장바구니 무게가 이 값보다 작으면 운송업체를 숨깁니다. 0은 제한이 없음을 의미합니다. Max cart weight보다 클 수 없습니다.

Max cart weight: kg 단위입니다. 장바구니 무게가 이 값보다 크면 운송업체를 숨깁니다. 기본값: 30. 0은 제한이 없음을, 빈 필드는 30 kg을 의미합니다. Correios PAC 및 SEDEX 소포는 최대 30 kg까지 가능합니다.

Minimum order amount: 장바구니 소계(배송이 필요한 상품, 할인 후, 세금 전)가 이 금액에 도달한 경우에만 운송업체를 표시합니다. 항상 표시하려면 비워 두십시오.

Free shipping: 아래 금액 이상일 때 무료 배송을 켭니다.

Free shipping from: 배송비가 무료가 되는 장바구니 소계(할인 후, 세금 전)입니다. 이 경우 API 요청은 이루어지지 않습니다.

배송 지역 없이 사용 가능

일반적으로 운송업체는 Shipping > Carriers에서 할당된 지역에 표시됩니다.

Ignore shipping zones: 어떤 지역이 일치하든 관계없이 아래 국가에 운송업체를 제공합니다. 저장 시 운송업체가 모든 지역에 추가됩니다. 이 옵션을 끄면 추가된 지역이 제거됩니다. 옵션이 켜져 있는 동안 나중에 생성된 지역은 자동으로 추가됩니다.

Countries: 이 모드의 배송 대상 국가입니다. 비워 두면 쇼핑몰의 모든 활성 국가가 사용됩니다. 이 필드는 Ignore shipping zones가 켜져 있을 때만 사용됩니다.

고급

Debug log: 요금 계산 내역을 모듈 폴더의 logs/vfd_crr_debug.log.php에 기록합니다. 이 파일은 웹에서 열 수 없습니다. API 오류는 이 옵션이 꺼져 있어도 항상 기록됩니다. API 사용자, 액세스 코드, posting card, 토큰 및 고객 CEP는 기록되지 않습니다.

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

Remove data on uninstall: 켜져 있으면 모듈을 제거할 때 설정, 운송업체, 주문 서비스, 캐시된 요금 및 로그가 삭제됩니다. 꺼져 있으면 재설치를 위해 모든 항목이 유지됩니다.

체크아웃에서의 작동 방식

배송 단계에서 PrestaShop은 모듈에 Correios 요금을 요청합니다. 실물 상품만 계산에 포함됩니다. 가상 상품은 무게를 더하지 않으며 주문 금액에도 포함되지 않습니다. 모듈은 먼저 조건을 확인합니다. 허용된 국가(Ignore shipping zones와 함께), 장바구니 무게, 최소 주문 금액입니다. 무료 배송이 적용되면 요금은 0이 되고 Correios로 요청이 전송되지 않습니다.

자격 증명이 설정된 브라질 주소의 경우, 모듈은 먼저 posting card에 대한 API 토큰을 가져옵니다. 이 토큰은 계약 번호와 지역 사무소 번호도 제공하므로, 요금은 귀하의 계약 요금이 됩니다. 그다음 발송지 CEP와 도착지 CEP, 그램 단위의 소포 무게, cm 단위의 소포 크기를 기준으로 선택한 서비스의 요금을 요청합니다. 도착지 CEP가 8자리인 경우에만 요금을 요청합니다. 모든 상품에 치수가 있으면 소포 크기는 그 치수로부터 추정됩니다. 그렇지 않으면 Correios 최소 크기가 전송됩니다. 30 kg을 초과하는 소포는 API로 전송되지 않습니다. BRL 요금은 귀하의 환율로 환산됩니다. 요금은 쇼핑몰의 기본 통화로 계산된 후, 고객의 장바구니 통화로 표시됩니다.

각 요금은 소포별로 1시간 동안 캐시됩니다. 실패한 요청은 10분 동안 캐시되므로, API 중단이 체크아웃의 모든 업데이트를 느리게 만들지 않습니다. 토큰은 만료 직전까지 캐시되며 자동으로 갱신됩니다. Correios가 토큰을 거부하면 새 토큰을 요청하고 요금 요청을 한 번 반복합니다. API 제한 시간은 12초입니다.

API가 요금을 반환하지 않으면 고정 요금이 사용되고, 고정 요금이 없으면 운송업체가 숨겨집니다. 고객은 API 오류 세부 정보를 전혀 보지 않습니다. 이 정보는 디버그 로그로 전달됩니다.

주문이 있는 운송업체를 Shipping > Carriers에서 편집하면, PrestaShop은 이를 새 운송업체 버전으로 저장합니다. 모듈은 새 버전을 자동으로 따릅니다.

모듈은 요금만 계산합니다. Correios 국제 요금(Exporta Fácil, Packet), 배송 기간 추정, 라벨, 사전 접수, 신고서 또는 추적 기능은 제공하지 않습니다. 고객은 Correios 지점이나 사물함을 선택할 수 없습니다. 부가 서비스(신고 가액, 직접 수령, 수령 확인)는 추가되지 않습니다. 쇼핑몰당 Correios 서비스 하나만 표시되며, 통화 환율은 자동으로 업데이트되지 않습니다.

주문

Correios 운송업체로 주문이 이루어지면, 모듈은 배송 요금이 어떻게 계산되었는지를 저장합니다. 백오피스의 주문 페이지에는 Correios service(실시간 요금의 경우 예: PAC — contract (03298))와 Price source(Live price (Correios API), Fixed price 또는 Free shipping)가 포함된 Correios 블록이 표시됩니다.

라이선스 키

이 모듈은 vibefox.net에서 받은 VibeFox 라이선스 키로 작동합니다. License — VibeFox Correios 라이선스 블록은 Modules > Module Manager > VibeFox Correios > Configure 페이지에서 설정 위에 있는 첫 번째 블록입니다. 키를 License key에 입력하고 Activate를 클릭하십시오. 그러면 블록에 마스킹된 키, 상태(예: 라이선스가 유효한 날짜와 도메인), 그리고 상태를 다시 확인하는 Check now, 다른 키를 입력하는 Change key, 이 쇼핑몰에서 키를 제거하는 Remove key 버튼이 표시됩니다. 그 아래에는 Product: presta-shipping-correios 줄과, vibefox.net 계정을 여는 Manage licenses and domains in your account 링크가 있습니다. 모듈에 대한 Configure 권한이 있는 직원만 키를 변경할 수 있습니다. 블록의 텍스트는 백오피스 언어를 따릅니다(영어와 러시아어 포함).

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

키 하나는 도메인 하나에서 작동합니다. 멀티스토어 설정에서도 기본 쇼핑몰의 도메인에 해당합니다. 쇼핑몰에서 키를 제거해도 도메인 슬롯은 해제되지 않습니다. vibefox.net 계정에서 슬롯을 해제하십시오.

활성 키가 없으면 체크아웃에서 고객에게 Correios 운송업체가 표시되지 않으며 요금도 계산되지 않습니다. PrestaShop 스토어프론트는 사용자가 백오피스에 로그인했는지 알지 못하므로, 운송업체는 사용자에게도 숨겨집니다. 키를 구매하기 전에 모듈을 설정할 수는 있지만, 체크아웃에서 테스트할 수는 없습니다. Modules > Module Manager의 Alerts 탭에 알림이 표시됩니다. 기존 주문은 영향을 받지 않습니다.

라이선스가 만료되어도 모듈은 계속 작동하지만, 업데이트와 지원에는 갱신이 필요합니다. 백오피스에서 작업하는 동안 상태는 자동으로 다시 확인됩니다. 키를 입력한 후 처음 14일 동안은 하루에 한 번, 그 이후에는 일주일에 한 번입니다. cron 작업은 필요하지 않습니다. 모듈을 제거하거나 재설정하면 라이선스 키와 라이선스 상태는 항상 삭제됩니다.

문제 해결

체크아웃에 Correios가 나타나지 않음: 라이선스가 활성 상태이고 Enable Correios가 켜져 있는지 확인하십시오. Shipping > Carriers에서 운송업체가 고객 국가의 지역과 고객 그룹을 포함하는지 확인하십시오(또는 Ignore shipping zones가 켜져 있고 해당 국가가 허용되어 있는지 확인하십시오). 무게 제한과 Minimum order amount를 확인하십시오. 실시간 요금이 없으면 해당 국가 또는 *에 대한 고정 요금이 있어야 합니다. 상품 페이지에서 상품이 특정 운송업체로 제한되어 있을 수도 있습니다.

운송업체가 Correios 요금 대신 고정 요금을 표시함: 모듈 페이지의 Log 필드를 확인하십시오. Correios 오류가 여기에 기록됩니다. 잘못된 액세스 코드, 계약에 없는 서비스, 서비스 불가 CEP, 30 kg을 초과하는 소포 또는 크기 제한 초과 등입니다. 또한 발송지 CEP가 설정되어 있는지, 고객의 CEP가 8자리인지, 그리고 기본 통화가 BRL이 아니면 BRL 환율이 설정되어 있는지 확인하십시오. 모든 계산을 확인하려면 Debug log를 켜십시오.

토큰 요청 실패: API 사용자, 액세스 코드, posting card 및 환경을 확인하십시오. Homologation 액세스 코드는 Homologation이 켜져 있을 때만, 운영 코드는 꺼져 있을 때만 작동합니다.

변경 후 요금이 오래된 것처럼 보임: 모듈 페이지에서 Save를 클릭하십시오. 이렇게 하면 캐시된 요금과 API 토큰이 지워집니다.

페이지에 Correios 운송업체를 찾을 수 없다고 표시됨: Shipping > Carriers에서 운송업체가 삭제되었습니다. Modules > Module Manager에서 모듈을 재설정하여 다시 생성하십시오.

저장 시 권한이 없다는 메시지가 표시됨: 직원 프로필에서는 모듈을 볼 수는 있지만 구성할 수는 없습니다. 설정을 저장하고 로그를 지우려면 모듈의 구성 권한이 필요합니다.

제거

Modules > Module Manager로 이동하여 VibeFox Correios 옆의 메뉴를 열고 Uninstall을 선택합니다. 라이선스 키, 라이선스 상태, 캐시된 요금과 토큰은 항상 제거됩니다. Remove data on uninstall이 켜져 있으면 운송업체가 삭제되고(주문은 기록을 유지합니다), 설정, 저장된 주문 서비스 및 로그가 제거됩니다. 꺼져 있으면 운송업체만 비활성화되고 모든 설정은 유지됩니다. 모듈을 다시 설치하면 운송업체가 이전 상태로 복원됩니다.

Correios는 해당 소유자의 상표입니다. 이 모듈은 Correios와 제휴하거나 Correios의 승인을 받지 않았습니다.