About the PayPal category

Alumio_Bot · February 5, 2024, 12:45pm

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation:

Connector package documentation

1. Setting up HTTP Client PayPal

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select PayPal HTTP Client as PlatForm and click next step
Fill in the Base URI, Access Token URL, Client ID, Client Secret and scopes.
(For more information, see PayPal Authentication Reference)
Click on the “Grant access to Paypal” button to get the key.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from PayPal

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select either “PayPal Subscriber” as the subscriber.
Select the entity you want to subscribe to from PayPal.
Add any request parameters needed to subscribe to the entity.
Select the PayPal HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from PayPal.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow PayPal documentation on building this connector, so you can easily use the connector based on PayPal API Reference.

Entity

The entity you want to subscribe to PayPal. Please refer to the entities from PayPal API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the PayPal API Reference .

Please look at the example below on how to fill path field when subscribing “Catalog Products - Show product details” entity.

Based on the documentation, we can see that the end point require “product_id” as a path. That is why we set the “product_id” inside the path key in the Request Parameters.

Alumio will then make a request to PayPal with the URL /v1/catalogs/products/PROD-4RL39819VJ076433A

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access PayPal.

3. Publishing Entity to PayPal

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select either “PayPal - Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the PayPal entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Put method, HTTP Patch method and HTTP Delete method on submitting data to PayPal.

Entity

We support publishing to most PayPal endpoints.
Please refer to PayPal API Reference page.

For example, we want to update a product. Please select “Patch” as the Method and “Catalog Products - Update product” as the entity of the publisher.

Based on the documentation, it requires require “product_id” as a path and request body. That is why we set the “product_id” inside the path key and the request body inside the payload key inside Alumio data.

Alumio will send an API request to PayPal with URL /v1/catalogs/products/PROD-4RL39819VJ076433A

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.