diff --git a/ups-connector-product/README.md b/ups-connector-product/README.md index 9c8f777..cc2db4e 100644 --- a/ups-connector-product/README.md +++ b/ups-connector-product/README.md @@ -1,19 +1,13 @@ -# UPS Modules +# UPS Module + +The Axon Ivy [UPS connector](https://developer.ups.com/catalog) enables users to integrate UPS services seamlessly into any business process. + +This connector: -## Description -The Axon Ivy [UPS connector](https://developer.ups.com/catalog) enables users to integrate UPS services seamlessly into any business process. This connector: - Empowers you with full access to the OpenAPI UPS API Catalog - Features everyday use cases such as tracking packages, obtain shipping rates, and validating addresses -- Provides an easy-to-copy demo implementation to streamline your integration efforts. -Explore the [API catalog](https://developer.ups.com/catalog) to identify which APIs align with your business needs. - -## Setup -1. Go to https://developer.ups.com, login with your user or create a new UPS account. -2. Create an application on UPS -3. Once your application is created, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token for authorizing your API requests -4. Configure the following variables in your project: -![Alt text](images/image-11.png) +Explore the [API catalog](https://developer.ups.com/catalog) to identify which APIs align best with your business needs. ## Demo ### Get tracking information @@ -71,3 +65,10 @@ This service is utilized to verify addresses against the United States Postal Se ![Alt text](images/image-10.png) 4. Click **Validate** button + +## Setup +1. Go to https://developer.ups.com, login with your user or create a new UPS account. +2. Create an application on UPS +3. Once your application is created, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token for authorizing your API requests +4. Configure the following variables in your project: +![Alt text](images/image-11.png) diff --git a/ups-connector-product/README_DE.md b/ups-connector-product/README_DE.md new file mode 100644 index 0000000..ae58020 --- /dev/null +++ b/ups-connector-product/README_DE.md @@ -0,0 +1,74 @@ +# UPS Konnektor + +Der Axon Ivy [UPS Konnektor](https://developer.ups.com/catalog) ermöglicht es dir, UPS-Dienste problemlos in deine Geschäftsprozess zu integrieren. + +Dieser Konnektor: + +- bietet dir vollen Zugriff auf den OpenAPI UPS API-Katalog +- unterstützt alltägliche Anwendungsfälle wie das Verfolgen von Paketen, das Ermitteln von Versandkosten und die Adressvalidierung + +Du kannst auch im [API-Katalog](https://developer.ups.com/catalog) stöbern, um die APIs zu finden, die am besten zu deinen Geschäftsanforderungen passen. + +## Demo +### Get tracking information +This service is used to retrieve package information. +1. Login to the Axon Ivy Portal +2. On the Process List page, click on **Get Tracking** + +![Alt text](images/image-1.png) + +3. Fill in your tracking number + +![Alt text](images/image-2.png) + +4. Click **Search** button to get all information of the package + +![Alt text](images/image-3.png) + +### Pickup Creation +This service is used to schedule pickups. +1. Login to the Axon Ivy Portal +2. On the Process List page, click on **Pickup Creation** + +![Alt text](images/image-5.png) + +3. Fill in required fields + +![Alt text](images/image-4.png) + +4. Click **Process** button to schedule pickups + +![Alt text](images/image-12.png) + +### Pickup cancel +This service is used to cancel previously scheduled pickups. +1. Login to the Axon Ivy Portal +2. On the Process List page, click on **Pickup Creation** + +![Alt text](images/image-8.png) + +3. Fill in required fields + +![Alt text](images/image-7.png) + +4. Click **Cancel** button to finish + +### Address validation +This service is utilized to verify addresses against the United States Postal Service database of valid addresses in the U.S. +1. Login to the Axon Ivy Portal +2. On the Process List page, click on **Validate Address** + +![Alt text](images/image-9.png) + +3. Fill in address info + +![Alt text](images/image-10.png) + +4. Click **Validate** button + +## Setup +1. Go to https://developer.ups.com, login with your user or create a new UPS account. +2. Create an application on UPS +3. Once your application is created, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token for authorizing your API requests +4. Configure the following variables in your project: +![Alt text](images/image-11.png)