From 83b7bb0c48c5ae84267b3bd1d6368c01de3e84c8 Mon Sep 17 00:00:00 2001 From: Kevin Venclovas Date: Fri, 19 Apr 2024 09:26:14 +0200 Subject: [PATCH] add readme path --- ShippingProAPICollection/README.md | 150 ------------------ .../ShippingProAPICollection.csproj | 4 + 2 files changed, 4 insertions(+), 150 deletions(-) delete mode 100644 ShippingProAPICollection/README.md diff --git a/ShippingProAPICollection/README.md b/ShippingProAPICollection/README.md deleted file mode 100644 index 42a8641..0000000 --- a/ShippingProAPICollection/README.md +++ /dev/null @@ -1,150 +0,0 @@ -[![Build&Test](https://github.com/kevinvenclovas/ShippingProAPICollection/actions/workflows/dotnet.yml/badge.svg)](https://github.com/kevinvenclovas/ShippingProAPICollection/actions/workflows/dotnet.yml) -[![NuGet](https://img.shields.io/nuget/v/ShippingProAPICollection.svg)](https://www.nuget.org/packages/ShippingProAPICollection/) -# Shipping Pro API Collection -Welcome to our C# library, designed to integrate multiple shipping service APIs into one streamlined solution. This project provides a unified interface for GLS GLS, DHL, and DPD, simplifying the shipping process for developers and businesses. With easy integration, you can handle logistics across different carriers seamlessly. Ideal for enhancing efficiency in e-commerce and logistics operations. - - -## Provider - -- [X] GLS GLS Germany ([API Documentation](https://GLS.gls-group.eu/webservices/3_2_9/doxygen/WS-REST-API/index.html)) - - [X] Create Shipment - - [X] Cancel Shipment - - [X] Validate Label - - [X] Get Estimated Delivery Days - -- [X] DHL Parcel Germany (2.1.8) ([API Documentation] (https://developer.dhl.com/api-reference/parcel-de-shipping-post-parcel-germany-v2#downloads-section)) - - [X] Create Shipment - - [X] Cancel Shipment - -- [X] DPD Germany (4.4) ([API Documentation] (https://esolutions.dpd.com/dokumente/ShipmentService_V4_4.pdf)) - - [X] Login (2.0) ([API Documentation] (https://esolutions.dpd.com/dokumente/LoginService_V2_0.pdf)) - - [X] Create Shipment - - [X] Cancel Shipment - -## Get Started -Before requesting shipping labels, you must first set up your specific shipping provider settings. This is achieved by injecting these settings as a singleton through dependency injection. - -To finalize the setup, register the ShippingProAPICollectionService as a scoped service in your application. - - services.AddScoped(); - ShippingProAPICollectionSettings providerSettings = new ShippingProAPICollectionSettings() - -#### GLS GLS - - GLSSettings GLSSettings = new GLSSettings() - { - // PLEASE GET IN TOUCH WITH YOUR GLS CONTACT TO GET THE FOLLOWING INFORMATIONS - - // Api domain is the XXXXXXX part of your GLS-GLS api url => https://GLS-wbm-XXXXXXX.gls-group.eu:443/backend/rs - ApiDomain = "test01", - ContactID = "276a45fkqM", - Username = "276a45fkqM" - Password = "lXZBIF7uRccyK7Ohr64d", - }; - providerSettings.AddSettings(GLSSettings); - -#### DHL Parcel DE Shipping - - DHLSettings dhlSettings = new DHLSettings() - { - // Api domain is the XXXXXXX part of your DHL api url => https://api-XXXXXXX.dhl.com/parcel/de/shipping/v2/ - ApiDomain = "sandbox", - Password = "pass", - Username = "sandy_sandbox", - DHLShipmentProfile = "STANDARD_GRUPPENPROFIL", - InternationalAccountNumber = "33333333335301", - NationalAccountNumber = "33333333330102", - LabelPrintFormat = "910-300-410", - // Create your DHL APP here -> https://developer.dhl.com/user/apps - APIKey = "", - APILanguage = "de-DE" // en-US or de-DE - }; - providerSettings.AddSettings(dhlSettings); - -#### DPD - - DPDSettings dpdSettings = new DPDSettings() - { - // Api domain is the XXXXXXX part of your DPD api url => https://public-XXXXXXX.dpd.com/services/ShipmentService/V4_4/ - ApiDomain = "ws-stage", - APILanguage = "de_DE", // en_EN or de_DE - DepotNumber = "0191", - Username = "sandboxdpd", - Password = "xMmshh1" - }; - providerSettings.AddSettings(dpdSettings); - - -## Add multiple contract accounts -At times, you may need to utilize multiple contract accounts from the same provider. You can add multiple contracts by specifying a contract ID like this: - - // Setup first contract - DPDSettings dpdContract1Settings = new DPDSettings() - { - // Api domain is the XXXXXXX part of your DPD api url => https://public-XXXXXXX.dpd.com/services/ShipmentService/V4_4/ - ApiDomain = "ws-stage", - APILanguage = "de_DE", // en_EN or de_DE - DepotNumber = "0191", - Username = "sandboxdpd", - Password = "xMmshh1" - }; - - providerSettings.AddSettings("DPD1", dpdContract1Settings); - - // Setup second contract - DPDSettings dpdContract3Settings = new DPDSettings() - { - // Api domain is the XXXXXXX part of your DPD api url => https://public-XXXXXXX.dpd.com/services/ShipmentService/V4_4/ - ApiDomain = "ws-stage", - APILanguage = "de_DE", // en_EN or de_DE - DepotNumber = "0191", - Username = "sandboxdpd", - Password = "xMmshh1" - }; - providerSettings.AddSettings("DPD2", dpdSettings); - -# Docker - -## Environment variables - -### Address -Name | Type | Required | Example ---- | --- | ---| --- -`ADDRESS_CITY` | String | * | Ellwangen -`ADDRESS_CONTACT_NAME` | String | * | Kevin Mustermann -`ADDRESS_COUNTRY_CODE_ISOA2` | String | * | DE -`ADDRESS_EMAIL` | String | * | kevin.mustermann@gmail.com -`ADDRESS_NAME` | String | * | Max GmbH -`ADDRESS_POSTCODE` | String | * | 73479 -`ADDRESS_STREET` | String | * | Max-Straße 15 -`ADDRESS_PHONE` | String | * | 0152012345678 - -### DPD -Name | Type | Required | Example ---- | --- | ---| --- -`DPD_API_DOMAIN` | String | * | ws-stage or ws -`DPD_API_LANGUAGE` | String | * | de_DE or en_EN -`DPD_DEPOT_NUMBER` | String | * | 0191 -`DPD_PASSWORD` | String | * | xMmshh1 -`DPD_USERNAME` | String | * | sandboxdpd - -### DHL -Name | Type | Required | Example ---- | --- | ---| --- -`DHL_API_DOMAIN` | String | * | sandbox or eu -`DHL_USERNAME` | String | * | sandy_sandbox -`DPD_PASSWORD` | String | * | pass -`DHL_INTERNATIONAL_ACCOUNT_NUMBER` | String | * | 33333333335301 -`DHL_NATIONAL_ACCOUNT_NUMBER` | String | * | 33333333330102 -`DHL_LABEL_FORMAT` | String | * | 910-300-410 -`DHL_API_KEY` | String | * | sandboxdpd -`DHL_API_LANGUAGE` | String | * | de-DE - - -### GLS -Name | Type | Required | Example ---- | --- | ---| --- -`GLS_API_DOMAIN` | String | * | test01 or de03 -`GLS_CONTRACT_ID` | String | * | 276a5fkqM -`GLS_PASSWORD` | String | * | lXZBIF7uccyK7Ohr64d -`GLS_USERNAME` | String | * | 276a5fkqM diff --git a/ShippingProAPICollection/ShippingProAPICollection.csproj b/ShippingProAPICollection/ShippingProAPICollection.csproj index 65e25bb..05d0a27 100644 --- a/ShippingProAPICollection/ShippingProAPICollection.csproj +++ b/ShippingProAPICollection/ShippingProAPICollection.csproj @@ -29,6 +29,10 @@ True \ + + True + \ +