Feature/36803 minor updates workflow collection #91

LiudmylaMasliuk · 2024-07-17T13:34:57Z

No description provided.

…tion

JonYeb · 2024-07-17T13:40:13Z

README.md

+The project demo website https://poc-mediaopt2.frontend.site/ is built using three parts:
+1. The connector itself, provided in this repository
+2. The PayPal client api for the frontend integration. The client is available at [npm](https://www.npmjs.com/package/paypal-commercetools-client) and [github](https://github.com/mediaopt/paypal-commercetools-client). If for some reason you can't use the client for your integration - you are obliged to use [PayPal JS SDK](https://developer.paypal.com/sdk/js/) instead.
+3. The client is integrated in commercetools frontend. Using commercetools frontend for storefront is optional. The integration details can be seen ad [github](https://github.com/mediaopt/paypal-commercetools-cofe-integration). 


can be seen here or in. Ad doesnt fit here.

JonYeb · 2024-07-17T13:41:48Z

README.md

+| client ID     | CTP_CLIENT_ID)         | the ID of your commercetools API client               |
+| client secret | CTP_CLIENT_SECRET      | the secret of your commercetools API client           |
+| scope         | CTP_SCOPE              | the scope of your commercetools API client            |
+
 - [PayPal business customer account](https://www.google.com/aclk?sa=l&ai=DChcSEwjPz82wyK2GAxWSiVAGHUwzAVoYABABGgJkZw&gclid=Cj0KCQjw3tCyBhDBARIsAEY0XNnOcx462M0ej3RizrdN9a_6fl2O5_bfwVqOOzyHxz_9M7L10B8NfL0aAgA6EALw_wcB&sig=AOD64_0bOBSNaFhCg-wypewofyWkrpoBWg&q&adurl&ved=2ahUKEwiIqcewyK2GAxXlSkEAHejBBbQQqyQoAHoECAIQDA) and [API client](https://developer.paypal.com/api/rest/#link-getclientidandclientsecret) credentials,namely:


You have a google search link. Did you mean https://www.paypal.com/de/business/getting-started ?

JonYeb · 2024-07-17T13:46:33Z

docs/workflows/README.MD

+
+# Installation
+
+The connector itself is the backend part of the payment process, it is designed to be used together with the [PayPal client api](https://www.npmjs.com/package/paypal-commercetools-client) for the frontend integration. If it is not possible for some reason you are obliged to use [PayPal JS SDK](https://developer.paypal.com/sdk/js/) instead. We also use commercetools frontend (further referred as CoFe), but it is an optional part, shown here for illustration how to develop necessary API for the PayPal client.


If it is not possible for some reason feels like the sentence is missing something. If what is not possible? Connector or Client API?

JonYeb · 2024-07-17T13:47:40Z

docs/workflows/README.MD

+
+## Connector installation
+
+There are two possible ways to integrate the connector, both fully covered in the mentioned documentation.


covered in what mentioned documentation? the following documentation?

JonYeb · 2024-07-17T13:49:44Z

docs/workflows/README.MD

+1. Installed [directly from the commercetools marketplace](https://docs.commercetools.com/merchant-center/connect).
+2. Create your own deployment using [commercetools connect API](https://docs.commercetools.com/connect/getting-started).
+
+The connector includes a merchant center application, which is automatically installed and deployed when installing the connector, but it might be needed to update the custom application link after the deployment, as described in [commercetools documentation](https://docs.commercetools.com/merchant-center-customizations/deployment-examples/commercetools-connect).


Can you try to restructure this sentence? I get it but it reads "weird" if you get what I mean.

JonYeb · 2024-07-17T13:55:22Z

docs/workflows/README.MD

+2. PayPal specific part, which includes setting the custom type for payment and obtaining the client token.
+3. PayPal payment method specific part, that can differ for different payment methods
+
+The first two categories are covered in the Postman collection Initial part, the third is provided separately for some methods in the corresponding subfolder of the Payment specific folder. To go through the whole payment process of a target method you need to follow first all the calls in initial folder in a Postman collection and then all the specific for this method. All the necessary data are already provided in the collection, so you can just run the requests and see the results.


Again, a bit of a convoluted sentence. Maybe something like:
... process of a target method you first need to follow all the calls found in the initial folder from the Postman collection. Then you need to look at the payment method specific calls ?

JonYeb · 2024-07-17T13:57:19Z

docs/workflows/README.MD

+## Payment method specific flow
+
+MOST OF THE METHODS REQUIRES USER APPROVAL AFTER CREATE PAYPAL ORDER. IT MEANS THAT THE USER SHOULD APPROVE THE ORDER VIA THE LINK, PROVIDED IN THE RESPONSE.
+In case if this is applicable for a certain method - it is mentioned in the method description. For sandbox testing sanbdox customer credentials or [sandbox testing cards provided in the PayPal documentation](https://developer.paypal.com/tools/sandbox/card-testing/) can be used to approve the order.


Typo sandbox customernot sanbdox ^^

JonYeb · 2024-07-17T13:59:26Z

docs/workflows/README.MD

+
+## Standard flow
+
+In this section we describe the flow that is used at our the [demo website](https://poc-mediaopt2.frontend.site/) where the PayPal client is integrated into CoFe and the connector is installed at the merchant center. It is important to note that the CoFe project structure involves two separate parts - frontend and backend and [our integration](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc) involves both of them.


at our demo website - no need for the

JonYeb · 2024-07-17T14:00:58Z

docs/workflows/README.MD

+
+In our integration the PayPal client components are imported at [CoFe frontend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/frontend) and the API required for proper communication between the components and commercetools HTTP API ((and therefore the PayPal commercetools connector) is developed at the [CoFe backend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/backend).
+
+The cart creation before the payment with PayPal begins and the checkout procedure after the PayPal payment is complete are created by standard CoFe methods and are out of scope of this documentation. To create the cart via only HTTP API please see the [official commercetools documentation](https://docs.commercetools.com/api/).


I think it would be only via HTTP... and not via only HTTP...

JonYeb · 2024-07-17T14:04:12Z

docs/workflows/README.MD

+
+1. On rendering the button the createPaymentUrl is called to obtain/generate the relevant payment id.
+2. If relevant getClientToken is called to obtain the client token at the PayPal side.
+3. The button is than rendered by the client via PayPal JS SDK.


then not than for time ;)

JonYeb · 2024-07-19T08:20:08Z

docs/workflows/README.md

+1. using only the connector for the backend side implementation 
+2. using the [PayPal client](https://www.npmjs.com/package/paypal-commercetools-client) in commercetools Frontend (CoFe) [integration](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main).
+
+The workflow that only includes backend calls through Postman is also provided as a [workflow Postman Collection](PayPal-commercetools-workflow.postman_collection.json).


Here and in the next sentence you use also. So I think here it can just be removed to be a bit prettier to read.

JonYeb · 2024-07-19T08:24:32Z

docs/workflows/README.md

+
+The workflow that only includes backend calls through Postman is also provided as a [workflow Postman Collection](PayPal-commercetools-workflow.postman_collection.json).
+
+The sequence diagram that show a bit more details about the backend side of a payment process with PayPal buy now payment is also provided at [sequence_diagram_paypal_payment.md](sequence_diagram_paypal_payment.md).


I think .. shows more details about... is a better structure.
Secondly Buy Now is a PayPal product so I would capitalize it.

JonYeb · 2024-07-19T08:29:44Z

docs/workflows/README.md

+2. as Pay Upon Invoice does not require immediate payment - we trigger a custom checkout process for pay upon invoice (with extra liability message)
+3. after the user completes invoice payment on the RatePay side the webhook at the connector side is triggered to capture the order.
+
+#### PayPal buy now


Again, capitalize Buy Now here

JonYeb · 2024-07-19T08:30:16Z

docs/workflows/README.md

+
+In this section we describe the flow that is used at our [demo website](https://poc-mediaopt2.frontend.site/) where the PayPal client is integrated into CoFe and the connector is installed at the merchant center. It is important to note that the CoFe project structure involves two separate parts - frontend and backend and [our integration](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc) involves both of them. Frontend is responsible for a client side and backend for the server (see also [Architecture.pdf](../Architecture.pdf)).
+
+In our integration the PayPal client components are imported at [CoFe frontend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/frontend) and the API required for proper communication between the components and commercetools HTTP API ((and therefore the PayPal commercetools connector) is developed at the [CoFe backend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/backend).


You have two opening brackets here? ((and therefore

LiudmylaMasliuk added 6 commits July 16, 2024 10:20

36803 - added some documentation for installation and workflow collec…

2499133

…tion

36803 - minor readme edits

e26e661

36803 - described first part of frontend flow

379e6aa

36803 - finished description of frontend side processes

8b88384

36803 - minor format fixes

0aa8b74

36803 - some documentation corrections

818726d

LiudmylaMasliuk requested a review from JonYeb July 17, 2024 13:34

JonYeb requested changes Jul 17, 2024

View reviewed changes

LiudmylaMasliuk added 3 commits July 18, 2024 09:13

Merge branch 'main' into feature/36803-minor-updates-workflow-collection

f3b48cc

36803 - fixes after review

d73ec09

36803 - fixed the workflows folder name and references to it

e17ad18

LiudmylaMasliuk requested a review from JonYeb July 18, 2024 08:12

LiudmylaMasliuk added 2 commits July 19, 2024 09:16

36803 - added sequence diagram and slightly modified readme text

a394642

36803 - added required steps to start payment

74c8fa3

JonYeb requested changes Jul 19, 2024

View reviewed changes

LiudmylaMasliuk added 2 commits July 19, 2024 11:31

Merge branch 'main' into feature/36803-minor-updates-workflow-collection

8da4ba1

36803 - minor fixes after review

4e25e9e

LiudmylaMasliuk requested a review from JonYeb August 12, 2024 11:15

JonYeb approved these changes Aug 12, 2024

View reviewed changes

LiudmylaMasliuk merged commit 75eb7b7 into main Aug 12, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/36803 minor updates workflow collection #91

Feature/36803 minor updates workflow collection #91

LiudmylaMasliuk commented Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 17, 2024

JonYeb Jul 19, 2024

JonYeb Jul 19, 2024

JonYeb Jul 19, 2024

JonYeb Jul 19, 2024


		# Installation

		The connector itself is the backend part of the payment process, it is designed to be used together with the [PayPal client api](https://www.npmjs.com/package/paypal-commercetools-client) for the frontend integration. If it is not possible for some reason you are obliged to use [PayPal JS SDK](https://developer.paypal.com/sdk/js/) instead. We also use commercetools frontend (further referred as CoFe), but it is an optional part, shown here for illustration how to develop necessary API for the PayPal client.


		## Connector installation

		There are two possible ways to integrate the connector, both fully covered in the mentioned documentation.


		## Standard flow

		In this section we describe the flow that is used at our the [demo website](https://poc-mediaopt2.frontend.site/) where the PayPal client is integrated into CoFe and the connector is installed at the merchant center. It is important to note that the CoFe project structure involves two separate parts - frontend and backend and [our integration](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc) involves both of them.


		In our integration the PayPal client components are imported at [CoFe frontend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/frontend) and the API required for proper communication between the components and commercetools HTTP API ((and therefore the PayPal commercetools connector) is developed at the [CoFe backend](https://github.com/mediaopt/paypal-commercetools-cofe-integration/tree/main/packages/poc/backend).

		The cart creation before the payment with PayPal begins and the checkout procedure after the PayPal payment is complete are created by standard CoFe methods and are out of scope of this documentation. To create the cart via only HTTP API please see the [official commercetools documentation](https://docs.commercetools.com/api/).


		The workflow that only includes backend calls through Postman is also provided as a [workflow Postman Collection](PayPal-commercetools-workflow.postman_collection.json).

		The sequence diagram that show a bit more details about the backend side of a payment process with PayPal buy now payment is also provided at [sequence_diagram_paypal_payment.md](sequence_diagram_paypal_payment.md).

Feature/36803 minor updates workflow collection #91

Feature/36803 minor updates workflow collection #91

Conversation

LiudmylaMasliuk commented Jul 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment