| Name | sdksio-postnl-ecommerce-apis-sdk JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Collection of PostNL API's for ecommerce processes |
| upload_time | 2023-09-25 12:01:08 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
postnl
sdksio
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with PostNL Ecommerce APIs
## Introduction
Collection of PostNL API's for ecommerce processes
## Install the Package
The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:
```python
pip install sdksio-postnl-ecommerce-apis-sdk==1.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/sdksio-postnl-ecommerce-apis-sdk/1.0.0
## Test the SDK
You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
```
pip install -r test-requirements.txt
pytest
```
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| `apikey` | `str` | |
The API client can be initialized as follows:
```python
from postnlecommerceapis.postnlecommerceapis_client import PostnlecommerceapisClient
from postnlecommerceapis.configuration import Environment
client = PostnlecommerceapisClient(
apikey='apikey'
)
```
## Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
### Fields
| Name | Description |
| --- | --- |
| production | **Default** |
| environment2 | - |
## Authorization
This API uses `Custom Header Signature`.
## List of APIs
* [Postalcodecheck](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/postalcodecheck.md)
* [Track Trace](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/track-trace.md)
* [Checkout](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/checkout.md)
* [Deliverydate](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/deliverydate.md)
* [Locations](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/locations.md)
* [Timeframes](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/timeframes.md)
* [Labelling](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/labelling.md)
* [Barcode](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/barcode.md)
* [Confirming](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/confirming.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "sdksio-postnl-ecommerce-apis-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "postnl,sdksio",
"author": "",
"author_email": "developer <developer+sdksio@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/60/b6/85a573387400b29ca79c1dab837cace7eb049aa60f88f6721319b56edec1/sdksio-postnl-ecommerce-apis-sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with PostNL Ecommerce APIs\n\n## Introduction\n\nCollection of PostNL API's for ecommerce processes\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install sdksio-postnl-ecommerce-apis-sdk==1.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/sdksio-postnl-ecommerce-apis-sdk/1.0.0\n\n## Test the SDK\n\nYou can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:\n\nNavigate to the root directory of the SDK and run the following commands\n\n```\npip install -r test-requirements.txt\npytest\n```\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `apikey` | `str` | |\n\nThe API client can be initialized as follows:\n\n```python\nfrom postnlecommerceapis.postnlecommerceapis_client import PostnlecommerceapisClient\nfrom postnlecommerceapis.configuration import Environment\n\nclient = PostnlecommerceapisClient(\n apikey='apikey'\n)\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n| --- | --- |\n| production | **Default** |\n| environment2 | - |\n\n## Authorization\n\nThis API uses `Custom Header Signature`.\n\n## List of APIs\n\n* [Postalcodecheck](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/postalcodecheck.md)\n* [Track Trace](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/track-trace.md)\n* [Checkout](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/checkout.md)\n* [Deliverydate](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/deliverydate.md)\n* [Locations](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/locations.md)\n* [Timeframes](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/timeframes.md)\n* [Labelling](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/labelling.md)\n* [Barcode](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/barcode.md)\n* [Confirming](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/controllers/confirming.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/postnl-ecommerce-apis-python-sdk/tree/1.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Collection of PostNL API's for ecommerce processes",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://postnl.pages.dev/"
},
"split_keywords": [
"postnl",
"sdksio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0884fe3e81dc53474dd5611cae0d4b6c0224b6ffbeb82ca770a087bf6729648",
"md5": "e513fe198e94be6ba94c29e805503607",
"sha256": "53e8cac3d859190ac751e1cb526cb1191742f8632f981060d3df7f57b5ebf47c"
},
"downloads": -1,
"filename": "sdksio_postnl_ecommerce_apis_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e513fe198e94be6ba94c29e805503607",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 214782,
"upload_time": "2023-09-25T12:01:06",
"upload_time_iso_8601": "2023-09-25T12:01:06.727622Z",
"url": "https://files.pythonhosted.org/packages/f0/88/4fe3e81dc53474dd5611cae0d4b6c0224b6ffbeb82ca770a087bf6729648/sdksio_postnl_ecommerce_apis_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60b685a573387400b29ca79c1dab837cace7eb049aa60f88f6721319b56edec1",
"md5": "3e2632e0f235561509c58a95d6f0aa50",
"sha256": "cb67d32eb644529fd8ae28eef3ec22fbe3a4038d49bab5f095e6fa5c364ff343"
},
"downloads": -1,
"filename": "sdksio-postnl-ecommerce-apis-sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3e2632e0f235561509c58a95d6f0aa50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 63896,
"upload_time": "2023-09-25T12:01:08",
"upload_time_iso_8601": "2023-09-25T12:01:08.958295Z",
"url": "https://files.pythonhosted.org/packages/60/b6/85a573387400b29ca79c1dab837cace7eb049aa60f88f6721319b56edec1/sdksio-postnl-ecommerce-apis-sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 12:01:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sdksio-postnl-ecommerce-apis-sdk"
}
