shop by(샵바이), API 기본 개념 알아보기

 

shop by(샵바이)는 오픈 API를 통해 쉽고 간편한 외부 서비스 연동으로, 비즈니스를 자유롭게 확장할 수 있습니다. 여기서 API란 Application Programming Interface의 약자로, 소프트웨어 간 상호 작용을 가능하게 하는 인터페이스를 말합니다. 쉽게 말해, API는 다른 소프트웨어 애플리케이션들이 서로 통신하고 데이터를 교환할 수 있도록 하는 규약입니다.

 

온라인 쇼핑몰에서 API를 적절히 활용하면, 다른 시스템과의 연동을 통해 보다 효율적으로 쇼핑몰 운영이 가능합니다. 데이터의 신속한 업데이트와 동기화, 자동화된 작업 처리, 유연한 기능 확장이 가능하여 쇼핑몰 고객들에게 더 나은 경험을 제공하고 경쟁력을 강화할 수 있죠. 또한, API를 사용함으로써 쇼핑몰은 빠르게 변화하는 시장 환경에 대응할 수 있는데요. 이커머스 운영 편의를 위한 외부 서비스가 출시되면, API를 통해 해당 기능을 쉽게 연동하여 사용할 수 있고, 다양한 파트너와의 협업을 통해 혁신적인 비즈니스 모델을 구축할 수 있습니다.

 

오늘은 온라인 비즈니스를 자유롭게 확장할 수 있는 샵바이 API 기본 개념을 알아보겠습니다!

 

 

---

 

용어 소개 

1) 샵바이 API

• NHN커머스에서 제공하는 오픈소스로서 (1) shop API (2) admin API (3) server API로 분류됩니다.
• shop API는 고객들이 접근하는 쇼핑몰 사이트 화면을 구성할 수 있는 소스입니다.
• sever API는 외부 시스템에서 shop by와 연동하는 등 샵바이 서버에 저장된 데이터를 또 따른 서버에서 호출할 때 사용할 수 있는 API입니다.
• 샵바이 API 문서에서는 현재 (1) shop API와 (3) server API만 공개하고 있습니다.

2) 스킨(skin)

• 쇼핑몰 고객들이 보는 쇼핑몰 프론트 화면 디자인(템플릿, 레이아웃)을 뜻합니다.

3) 어드민(관리자)

• 쇼핑몰 운영자가 사용하는 화면으로 상품, 주문, 회원 관리 등 쇼핑몰을 관리하는 화면입니다. 

 

 

샵바이 API 호출 및 연동 개념

 

샵바이 API는 RESTful한 아키텍쳐로서 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다. 위 이미지와 같이, 샵바이의 모든 스킨들은 샵바이 솔루션에서 제공하는 샵바이API를 RESTful한 방식으로 호출하여 어드민과 연동합니다.

(*Restful: 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스)

 

 

로그인 상태 구분

쇼핑몰에서는 회원(member)과 비회원(guest)을 판별하기 위해, 로그인 상태 여부를 구분하는 것이 중요합니다. 앞으로 업로드될 콘텐츠 화면별 설명에서는 고객이 로그인을 했는지(=회원) 또는 하지 않았는지(=비회원)에 따라 사용되는 API가 다를 수 있으므로, 로그인 상태 여부를 판단하는 로직에 대해 소개 드리겠습니다.

 

 

샵바이에서는 액세스 토큰(accessToken) 기반의 로그인 방식을 사용합니다. 기본적으로 액세스 토큰의 존재 유무에 따라 로그인 상태를 구분할 수 있으며, 그 외 액세스 토큰 의 유효 기간 및 샵바이 API의 에러 응답 값에 따라 로그인 상태가 결정됩니다. 새로고침 혹은 쇼핑몰 내 다른 페이지 접근 시에도 로그인 상태를 유지하기 위해, 액세스 토큰 및 유효 기간 정보를 local Storage 에 저장해서 사용할 것을 권장 드립니다. 액세스 토큰 발급 API 등 보다 자세한 내용은 로그인 화면 문서를 통해 확인하실 수 있습니다.

 

---

 

 

NHN커머스에서는 '워크스페이스' 공간을 통해 API 문서를 제공하고 있는데요. 다양한 정보와 기능을 함께 공유할 수 있는 '포럼'부터 편리한 디자인과 개발 환경까지 갖춰져 있으므로, 워크스페이스에서 비즈니스를 자유롭게 확장해 보시기 바랍니다! 앞으로 API를 통해 쇼핑몰 결제 시스템 연동, 선물하기 기능 도입, 배송 서비스 연동 등 다양한 콘텐츠를 전달 드릴 예정이니, 많은 기대 부탁드립니다.​

지금 바로 하단 배너를 방문해 샵바이 쇼핑몰을 신청하고, 워크스페이스를 직접 경험해 보세요.