Browse Source

README.rst: Major update, expand more on what is required for which API

master
Harald Welte 5 months ago
parent
commit
eabc28d02a
  1. 39
      README.rst

39
README.rst

@ -1,3 +1,6 @@
python-inema
============
This is a python module for interfacing the "Internetmarke" API provided
by the German postal company "Deutsche Post". It implements V3 of this
API. It also implements the new (2020) "Warenpost International API".
@ -6,14 +9,34 @@ The Internetmarke API allows you to buy online franking for national and
international postal products like post cards and letters of all weight
classes and service classes (normal, registered, ...).
In order to use this module, you will need to be registered with
Deutsche Post for accessing the "1C4A Webservice". You can request
related details from pcf-1click@deutschepost.de. Upon registration,
you will receive your individual parameters PARTNER_ID, KEY and
KEY_PHASE.
Internetmarke API
-----------------
Furthermore, for actual payment of purchases made via this API, you will
need the user name (email address) and password to a "Portokasse"
account.
In order to use the Internetmarke API (SOAP), you will need to be registered
with Deutsche Post for accessing the "1C4A Webservice". You can request
related details from pcf-1click@deutschepost.de. Upon registration, you
will receive your individual parameters PARTNER_ID, KEY and KEY_PHASE.
This module makes use of the fairly new "zeep" module for SOAP/WSDL.
Warenpost International API
---------------------------
In order to use the Warenpost International API (REST), you will need to
be separately registered with Deutsche Post for accessing that API.
Upon registration, you will have the following individual parameters,
which you must use when initializing the WarenpostInt() class:
- PARTNER_ID
- SCHLUESSEL_DPWN_PARTNER (same as KEY?)
- EKP
- KEY_PHASE
Portokasse
----------
Furthermore, for actual payment of purchases made via both APIs, you
will need the user name (email address) and password to a "Portokasse"
account.
Loading…
Cancel
Save