Skip to content
This repository was archived by the owner on Sep 21, 2023. It is now read-only.

Commit 26a7e9a

Browse files
committed
Updated readme and created basic tutorial
1 parent b271508 commit 26a7e9a

File tree

2 files changed

+445
-27
lines changed

2 files changed

+445
-27
lines changed

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This *unofficial* library is wrapping some functions of the DHL SOAP API in order to easy create/delete shipments and labels.
44

5+
## Requirements
6+
7+
- You need a [DHL developer Account](https://entwickler.dhl.de/) and - as long as you want to use the API in production systems - a DHL Intraship Account.
8+
- PHP-SOAP-Client installed + enabled on your Server. [More information on php.net](http://php.net/manual/en/soap.setup.php)
9+
510
## Installation
611

712
### Composer
@@ -21,43 +26,38 @@ If you can't use Composer (or don't want to), you can also use this SDK without
2126
To initial this SDK, just require the [_nonComposerLoader.php](https://github.com/Petschko/dhl-php-sdk/blob/master/includes/_nonComposerLoader.php)-File from the `/includes/` directory.
2227

2328
```php
24-
require_once('includes' . DIRECTORY_SEPARATOR . '_nonComposerLoader.php');
29+
require_once(__DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . '_nonComposerLoader.php');
2530
```
2631

27-
## Motivation
28-
29-
I had a lot of pain studying and programming the DHL SOAP API - just to wrap some bits in a lot of XML. There is a lot, but not very helpful, documentation to the API. So I decided to create some functions in an easy to use and understand library.
30-
31-
There is also a lot of old stuff in the Documentation, so that you can not sure if it is right...
32-
33-
## Requirements
34-
35-
- You need a DHL developer account and - as long as you want to use the API in production systems - a DHL Intraship Account.
36-
- PHP-SOAP-Client installed + enabled on your Server
37-
3832
## Compatibility
3933

4034
This Project is written for the DHL-SOAP-API **Version 2 or higher**.
4135

42-
It barely supports Version 1, feel free to complete the missing functions for Version 1. They are named usually `{functionname}_v1`. They are also marked with "todo" if they are not implemented
36+
Version 1 Methods are marked as @deprecated and will removed soon. Please upgrade to the API-Version 2 as soon as possible.
4337

44-
I can't find a Documentation for Version 1 anymore, so its hard to implement them properly...
38+
## Usage / Getting started
4539

46-
## Usage
40+
- [Getting started (Just a quick guide how you have to use it)](https://github.com/Petschko/dhl-php-sdk/blob/master/examples/getting-started.md)
41+
- _More examples soon_
4742

48-
**todo: add links for some examples here**
49-
50-
Please have a look at the `examples` Directory. There you can find how to use this SDK also with Code-Examples, else check the [Documentation](http://docs.petschko.org/dhl-php-sdk/index.html) for deeper knowledge.
43+
Please have a look at the [`examples` Directory](https://github.com/Petschko/dhl-php-sdk/tree/master/examples). There you can find how to use this SDK also with Code-Examples, else check the _(Doxygen)_ [Documentation](http://docs.petschko.org/dhl-php-sdk/index.html) for deeper knowledge.
5144

5245
## Code Documentation
5346

5447
You find Code-Examples with explanations in the `examples` Directory. I also explain how it works.
5548

5649
You can find a Code-Reference here: _(Doxygen)_ http://docs.petschko.org/dhl-php-sdk/index.html
5750

51+
## Motivation
52+
53+
I had a lot of pain studying and programming the DHL SOAP API - just to wrap some bits in a lot of XML. There is a lot, but not very helpful, documentation to the API. So I decided to create some functions in an easy to use and understand library.
54+
55+
There is also a lot of old stuff in the Documentation, so that you can not sure if it is right...
56+
5857
## Credits
5958

6059
All these Persons helped to create this SDK for the DHL-API:
60+
- [aschempp](https://github.com/aschempp) - For the help with the Notification E-Mail
6161
- [cedricziel](https://github.com/cedricziel) - For turning this Project into a [Composer](https://getcomposer.org/)-Package
6262
- [Dakror](https://github.com/Dakror) - For the `ProductInfo`-Class
6363
- [octlabs](https://github.com/octlabs) - For adding some missing Documentation
@@ -71,12 +71,3 @@ All these Persons helped to create this SDK for the DHL-API:
7171
- You can Report Bugs here in the "[Issue](https://github.com/Petschko/dhl-php-sdk/issues)"-Section of the Project.
7272
- Of course you can also ask any stuff there, feel free for that!
7373
- If you want to use German, you can do it. Please keep in mind that not everybody can speak German, so it's better to use english =)
74-
75-
### DHL-API Version 1 Code
76-
77-
You can find my old Version here:
78-
[Download old Code](https://github.com/Petschko/dhl-php-sdk/releases/download/v0.1/dhl-php-sdk_v0.1.zip)
79-
80-
You can also look at the Tobias Redmann's Code, I initially forked that repo. There are not a lot of his code left in my current Version, but you can find his Code better than mine... (His Version supports just DHL-SOAP-Version 1)
81-
82-
He also Build several Plugins for Wordpress + Woocommerce in the past. Check his [GitHub-Page](https://github.com/tobias-redmann) or his [Homepage](http://www.tricd.de)

0 commit comments

Comments
 (0)