API 파트너 통합 가이드(공개 앱)

Wish API 파트너 통합자들이 Wish API 문서를 더 잘 이해할 수 있도록, 예를 들어 판매자 대시보드와 비교했을 때 API를 통해서는 어떠한 작업을 수행할 수 있는지, Wish에 대한 통합 구축 시 지원해야 하는 중요한 기능은 어떤 것들인지 등을 잘 이해할 수 있도록, 다음과 같은 가이드를 만들었으며, 이를 통해 파트너들에게 API를 사용해 공개 앱을 구축하는 방법을 보여줍니다. 다음 각 단계를 따르십시오.

 

1. Wish 샌드박스 환경에서 공개 앱에 가입합니다.

1). Partner registers as ERP via the ERP Signup page on Wish sandbox environment. Partner can review Wish API documentation.

2). 파트너가 Wish 파트너 API 이메일(partner-api@wish.com)로 연락하여 Wish 샌드박스 환경에 대한 파트너 API 액세스를 신청했다고 Wish에 알립니다.

3). Wish가 파트너의 신청서를 승인합니다.

4). 파트너가 승인되면, 파트너는 로그인을 해야 합니다.

5). 계정 > 앱 만들기를 클릭하십시오.

앱 이름을 만듭니다(판매자가 볼 이름을 사용하십시오). OAuth에 리디렉션 URL이 필요합니다(인증이 전송되는 위치이며, 언제든지 변경할 수 있음).

     Please note, the details on the above page in Sandbox will not be seen by merchants. 

6). Partner will be provided with a client ID and client secret, which will be used by the Partner to do merchant account testing on Wish sandbox (Wish API OAuth process on sandbox requires client ID and client secret).

 

2. 파트너는 샌드박스에서 판매자로서 두 번째 로그인을 진행합니다. 샌드박스 환경에서 이루어지는 작업이기 때문에, 파트너가 입력하는 판매자 정보는 실제 판매자의 정보가 아니어도 괜찮습니다.

1). 파트너는 ERP 등록에서 사용한 이메일과는 다른 이메일 주소를 사용하여 Wish에 로그인하고 판매자로서 공개 앱 개발을 시작합니다.

2). 가짜 판매자 계정을 ERP 파트너와 연결하십시오.

a). 샌드박스에서 판매자로 로그인한 경우 판매자는 URL을 https://sandbox.merchant.wish.com/v3/oauth/authorize?client_id={client_id}로 변경해야 합니다.  여기서 {client_id}은(는) ERP가 공개 앱을 만들 때 생성한 고객 ID입니다. 이렇게 하면 판매자 스토어에 대한 전체 액세스 권한을 가질 수 있도록 판매자에게 ERP를 승인하라는메시지가 표시됩니다.

b). 판매자가 권한을 승인하면 URL이 https://example.redirect.uri.com?code={authorization_code}로 변경됩니다(해당 리디렉션은 ERP가 공개 앱 생성 시 지정됩니다).

c). 이제 일반적인 oAuth 절차를 실행할 수 있습니다.

d). 모든 API 요청은 access_token을 포함해야 합니다. 액세스 토큰은 30일 동안 유효합니다.

e). 새로운 액세스 토큰을 얻기 위해 refresh_token을 사용할 수 있습니다. 이 작업을 수행하면 이전 토큰이 무효화됩니다.

3). 파트너는 Wish 샌드박스 환경에서 모든 테스트를 진행합니다.

4). 진행 시 Wish의 추가적인 승인이 필요하지 않습니다.

 

3. Wish 프로덕션 환경에서 공개 앱에 가입합니다.

1). Partner registers as ERP in production via the ERP Signup page on Wish production environment.

2). 파트너가 Wish 파트너 API 이메일(partner-api@wish.com)로 연락하여 Wish 프로덕션 환경에 대한 파트너 API 액세스를 신청했다고 Wish에 알립니다.

3). Wish는 파트너의 신청을 승인하거나 확인된 문제를 파트너에게 알립니다.

4). Once approved, you may login and select Account > Create App.

Partner enters information to be published in the Wish App Store. App name and Redirect URL are required fields. Partner may also enter additional information, such as app logo, value proposition, description, website and/or support email, which need to undergo a review process as they will be visible to merchants.

If this additional information is entered, the app will still be created and be able to integrate with the API, however, these fields will only be published in the Wish App Store once they are approved. In the meantime, the approval status of these additional information fields can be viewed as shown below.

You can view and edit all information submitted above (required or additional) by navigating to Account > App Settings. If the details in the additional information fields are edited or deleted, they will need to undergo the review process again.

5). Wish 프로덕션 환경 API 문서를 검토합니다.

6). 파트너가 OAuth 절차를 완료합니다.

7). 파트너는 Wish 프로덕션 환경에서 통합을 켜고, 샌드박스 환경 대신 Wish 프로덕션 환경에서 API 호출을 적용해야 합니다.

 

4. 판매자는 Wish 판매자 대시보드에서 고유 스토어 계정을 등록해야 하며, ERP가 판매자의 Wish 스토어에서 데이터를 받거나 보낼 수 있도록 권한을 부여해야 합니다. 

1). 판매자 계정 등록 절차의 일부로, 판매자는 사업자 등록 및 개인 정보 ID를 입증하는 정보를 제출해야 하며, Wish가 이를 승인합니다.

2). 판매자 계정은 Wish 계정 관리 담당자에 의해 승인됩니다.

3). Merchants then need to authorize ERP through one of the following methods: 

a). Merchant registers for an account at the ERP of their choice.

(i) Merchant selects Wish authorization link from ERP interface to redirect them to an OAuth Authorization page where they can authorize the ERP.

• The link should be as follows with the ERPs unique production client ID: https://merchant.wish.com/v3/oauth/authorize?client_id={PRODUCTION_CLIENT_ID}

(ii) Merchant clicks ‘Authorize’ to redirect them to the ERP specified "Redirect URI" with an authorization code. ERP will use this authorization code to call Wish APIs to get access token.

b). Merchant discovers ERP on the Wish App Store (NOTE: this process is not yet launched, but ERPs should be able to handle this process in preparation for its future launch):

(i) Merchant selects ‘Add App’ to redirect them to an OAuth Authorization page where they can authorize the ERP.

(ii) Merchant clicks ‘Authorize’ to redirect them to the ERP specified "Redirect URI" with an authorization code. ERP will use this authorization code to call Wish APIs to get access token.

• The connection may not be complete if the ERP specified “Redirect URI” page cannot handle the case where the merchant is not signed in and/or doesn't have an account with the ERP.

• To complete the connection, prompt the merchant to log in or sign up for your ERP. Then, carry the authorization code forward in the url, and complete the OAuth process once the merchant is logged in or has created an account.

c). Authorization is now complete.

d). If at any point the merchant intends to de-authorize the ERP, the merchant can do so from Wish Merchant Dashboard at Account > Settings > API Settings.

 

Please note to improve security for public apps, partners are now able to add up to 2 OAuth client secrets for their public apps. Simply navigate to your App Settings page and click “Add second key” under the first client secret to add a second one:

If needed, partners may also rotate the 2 client secrets by deleting one and adding a new one, in case their client secrets have been compromised.

 

Note: For links to documentation, tips, tutorials, and more check out the Wish Developers Page.