From 9fa4770776d0d2e5670a88a9c02dbc34e8354559 Mon Sep 17 00:00:00 2001 From: Khanh Nguyen <119989010+ndkhanh-axonivy@users.noreply.github.com> Date: Thu, 22 Feb 2024 16:22:26 +0700 Subject: [PATCH] Revert doc (#4) * revert document --- ups-connector-product/README.md | 75 ++++++++++++--------------------- 1 file changed, 28 insertions(+), 47 deletions(-) diff --git a/ups-connector-product/README.md b/ups-connector-product/README.md index 2f0e09f..ec9e199 100644 --- a/ups-connector-product/README.md +++ b/ups-connector-product/README.md @@ -1,93 +1,74 @@ # UPS Modules ## Description -This is a UPS module built in the Axon Ivy framework, enabling users to seamlessly integrate with UPS services. With this app, users can effortlessly manage their packages through UPS. - +This is a UPS modules made in Axon Ivy framework. It allows users to quickly and easily integrate with UPS Service. With this App, users can effortlessly manage their packages from UPS. With this connector: -- Empowers you with full access to the OpenAPI UPS services. -- Provides an easy-to-copy demo implementation to streamline your integration efforts. +- Gives you full power to the OpenAPI UPS services. +- Supports you with an easy-to-copy demo implementation to reduce your integration effort. -The UPS modules comprises the following components: +UPS modules contains: - ups-connector - ups-oauth-feature - ups-connector-demo - ups-connector-product - ups-connector-test -Common use cases for UPS APIs include: -- Shipping and tracking packages for your business. -- Obtaining shipping rates and transit times for e-commerce. -- Creating visibility applications for your customers on your platform. +Common use cases for UPS APIs: +- Shipping and tracking packages for your business +- Obtaining shipping rates and time in transit for ecommerce +- Creating visibility applications for your customers on your platform -Explore the [API catalog](https://developer.ups.com/catalog) to identify which APIs align with your business needs. -We hope you enjoy using this module, and we look forward to your contributions! +View the [API catalog](https://developer.ups.com/catalog) to identify which APIs meet your business needs. +We hope you enjoy and we look forward to your contributions! ## Set up -1. Visit https://developer.ups.com, log in, or create a new UPS accoun. -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 +1. Go to https://developer.ups.com, login or create a new UPS account. +2. Create an Application on UPS +3. After creating your application, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token to authorize your API requests 4. Configure the following variables in your project: -![Alt text](./images/image-11.png) +![Alt text](image-11.png) ## Demo ### Get tracking information -This service is used to retrieve package 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) - +![Alt text](image-1.png) 3. Fill in your tracking number - -![Alt text](./images/image-2.png) - +![Alt text](image-2.png) 4. Click **Search** button to get all information of the package - -![Alt text](./images/image-3.png) +![Alt text](image-3.png) ### Pickup Creation -This service is used to schedule pickups. +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) - +![Alt text](image-5.png) 3. Fill in required fields - -![Alt text](./images/image-4.png) - +![Alt text](image-4.png) 4. Click **Process** button to schedule pickups - -![Alt text](./images/image-12.png) +![Alt text](image-12.png) ### Pickup cancel -This service is used to cancel previously scheduled pickups. +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) - +![Alt text](image-8.png) 3. Fill in required fields - -![Alt text](./images/image-7.png) - +![Alt text](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. +This service is used to check 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) - +![Alt text](image-9.png) 3. Fill in address info - -![Alt text](./images/image-10.png) - +![Alt text](image-10.png) 4. Click **Validate** button