Wish APIパートナーインテグレーターがWish APIドキュメンテーション、販売元ダッシュボードとAPIを用いて行うことができるアクションの違い、およびWishとのインテグレーションを構築する際に必要不可欠な機能を理解しやすいように、弊社では、APIパートナーが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が必要です(認証情報が送信されます。いつでも変更することができます)。
サンドボックスの上記のページの詳細は販売元に表示されません。
6). パートナーにクライアントIDとクライアントシークレットが提供されます。販売元はそれらを使用して、Wishサンドボックスでアカウントのテストを実行できます(WishのAPI OAuth処理にはクライアントIDとクライアントシークレットが必要となります)。
2. パートナーは販売元として2度目のログインをサンドボックスで行ってください。サンドボックス環境のため、パートナーが入力する販売元の情報は実際の販売元の情報である必要はありません。
1). パートナーは、ERP登録からの異なるメールを用いてWishにログインし、販売元として公開アプリ開発を開始してください。
2). 販売元の偽アカウントとERPパートナーの関連付けを行ってください。
a). サンドボックスで販売元としてログインした場合、販売元はURLを{client_id}が公開アプリ作成時にERPが作成したclient_idであるhttps://sandbox.merchant.wish.com/v3/oauth/authorize?client_id={client_id}へと変更してください。この処理を行うことで、ERPが販売元のストアへのフルアクセスを認証するよう販売元に対して指示が示されます。
b). 販売元が許可することで、URLはERPが公開アプリを作成した時にリダイレクトが特定されたhttps://example.redirect.uri.com?code={{authorization_code}に変更されます。
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). 許可を得た後、ログインを行い[アカウント] > [アプリを作成]を選択することができます。
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.
上記のとおり送信されたすべての情報(必須情報、あるいは追加情報)は、[アカウント] > [アプリ設定]の手順で確認や編集を行うことができます。追加情報フィールドの詳細が編集されたり削除された場合は、再度審査が必要となります。
5). Wishの生産環境のドキュメンテーションの審査
6). パートナーがOAuth処理を完了します。
7). パートナーはWishの生産環境で統合をオンにして、APIコールがWishのサンドボックス環境ではなく生産環境を指し示していることを確かにしてください。
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) 販売元は、ERPのインターフェイスから得たWishの認証リンクでOAuthの認証ページへと移動してERPを認証することができます。
•ERPのユニーク生産クライアントIDを有するリンクは以下のとおりです。https://merchant.wish.com/v3/oauth/authorize?client_id={PRODUCTION_CLIENT_ID}
(ii) 販売元は、[認証]をクリックして、認証コードを用いてERPが指定する[リダイレクトURL]へと移動します。ERPはこの認証コードを用いてWishのAPIをコールしてトークンへのアクセス権を取得します。
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) 販売元は、[アプリを追加]を選択してOAuth認証ページに移動してERPを認証することができます。
(ii) 販売元は、[認証]をクリックして認証コードを用い、ERPが指定する[リダイレクトURL]へと移動します。ERPはこの認証コードを用いてWishのAPIをコールしてトークンへのアクセス権を取得します。
•販売元が登録されていない、さらに/あるいはERPアカウントを保持しておらず、ERP指定の「リダイレクトURL]ページが本ケースの処理を行うことができない場合は、関連付けを完了することができない可能性があります。
• 関連付けを完了するには、該当するERPにログインするか登録するよう販売元までご連絡ください。その後、URLで認証コードを用いて処理を進め、販売元のログイン、あるいはアカウントの作成後、OAuthの処理を完了してください。
c). 認証処理が完了しました。
d). 販売元がERPの認証を解除する場合は、Wishの販売元ダッシュボードから[アカウント] > [設定] >[API設定]で行うことができます。
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.
コメント
0件のコメント
サインインしてコメントを残してください。