| Name | postnl-sdk JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | Collection of PostNL API's for ecommerce processes. |
| upload_time | 2024-04-18 09:31:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
postnl
sdk
api
ecommerce
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with PostNL
## Introduction
This is an API description. Add as many details as you like.
## 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 postnl-sdk==1.0.2
```
You can also view the package at:
https://pypi.python.org/pypi/postnl-sdk/1.0.2
## 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.](doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION_SERVER`** |
| `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: 3** |
| `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']** |
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](__base_path/$a/custom-header-signature.md) | The credential object for Custom Header Signature |
The API client can be initialized as follows:
```python
client = PostnlClient(
custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
apikey='apikey'
)
)
```
API calls return an `ApiResponse` object that includes the following fields:
| Field | Description |
| --- | --- |
| `status_code` | Status code of the HTTP response |
| `reason_phrase` | Reason phrase of the HTTP response |
| `headers` | Headers of the HTTP response as a dictionary |
| `text` | The body of the HTTP response as a string |
| `request` | HTTP request info |
| `errors` | Errors, if they exist |
| `body` | The deserialized body of the HTTP response |
## Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
### Fields
| Name | Description |
| --- | --- |
| Production server | **Default** |
| Non-Production server | - |
## Authorization
This API uses the following authentication schemes.
* [`APIKeyHeader (Custom Header Signature)`](__base_path/$a/custom-header-signature.md)
## List of APIs
* [Postalcodecheck](doc/controllers/postalcodecheck.md)
* [Track Trace](doc/controllers/track-trace.md)
* [Barcode](doc/controllers/barcode.md)
* [Checkout](doc/controllers/checkout.md)
* [Confirming](doc/controllers/confirming.md)
* [Deliverydate](doc/controllers/deliverydate.md)
* [Labelling](doc/controllers/labelling.md)
* [Locations](doc/controllers/locations.md)
* [Shipment](doc/controllers/shipment.md)
* [Timeframes](doc/controllers/timeframes.md)
## Classes Documentation
* [Utility Classes](doc/utility-classes.md)
* [HttpResponse](doc/http-response.md)
* [HttpRequest](doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "postnl-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "PostNL, SDK, API, ecommerce",
"author": null,
"author_email": "PostNL <apimatic@postnl.nl>",
"download_url": "https://files.pythonhosted.org/packages/c0/08/4fc71b92528f81f0bfb8cc37886713a455d5b0751873aca584bc89638439/postnl_sdk-1.0.2.tar.gz",
"platform": null,
"description": "\n# Getting Started with PostNL\n\n## Introduction\n\nThis is an API description. Add as many details as you like.\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 postnl-sdk==1.0.2\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/postnl-sdk/1.0.2\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.](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_SERVER`** |\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: 3** |\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| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](__base_path/$a/custom-header-signature.md) | The credential object for Custom Header Signature |\n\nThe API client can be initialized as follows:\n\n```python\nclient = PostnlClient(\n custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(\n apikey='apikey'\n )\n)\n```\n\nAPI calls return an `ApiResponse` object that includes the following fields:\n\n| Field | Description |\n| --- | --- |\n| `status_code` | Status code of the HTTP response |\n| `reason_phrase` | Reason phrase of the HTTP response |\n| `headers` | Headers of the HTTP response as a dictionary |\n| `text` | The body of the HTTP response as a string |\n| `request` | HTTP request info |\n| `errors` | Errors, if they exist |\n| `body` | The deserialized body of the HTTP response |\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 server | **Default** |\n| Non-Production server | - |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`APIKeyHeader (Custom Header Signature)`](__base_path/$a/custom-header-signature.md)\n\n## List of APIs\n\n* [Postalcodecheck](doc/controllers/postalcodecheck.md)\n* [Track Trace](doc/controllers/track-trace.md)\n* [Barcode](doc/controllers/barcode.md)\n* [Checkout](doc/controllers/checkout.md)\n* [Confirming](doc/controllers/confirming.md)\n* [Deliverydate](doc/controllers/deliverydate.md)\n* [Labelling](doc/controllers/labelling.md)\n* [Locations](doc/controllers/locations.md)\n* [Shipment](doc/controllers/shipment.md)\n* [Timeframes](doc/controllers/timeframes.md)\n\n## Classes Documentation\n\n* [Utility Classes](doc/utility-classes.md)\n* [HttpResponse](doc/http-response.md)\n* [HttpRequest](doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Collection of PostNL API's for ecommerce processes.",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://developer.postnl.nl/"
},
"split_keywords": [
"postnl",
" sdk",
" api",
" ecommerce"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d224d081709610405333af70bb2165c8a78379813ccaf3b71db77be31b7a4f9",
"md5": "d4301844eb7a5efeae95e59a6d599fad",
"sha256": "0419b4073c521828bb097692e5b086a3696ee6e36a8aa060ab7cbf2b048cc440"
},
"downloads": -1,
"filename": "postnl_sdk-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4301844eb7a5efeae95e59a6d599fad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 174086,
"upload_time": "2024-04-18T09:31:28",
"upload_time_iso_8601": "2024-04-18T09:31:28.778438Z",
"url": "https://files.pythonhosted.org/packages/1d/22/4d081709610405333af70bb2165c8a78379813ccaf3b71db77be31b7a4f9/postnl_sdk-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0084fc71b92528f81f0bfb8cc37886713a455d5b0751873aca584bc89638439",
"md5": "524e20ff02ccd841bd20a1590c6e1077",
"sha256": "ecd7764b7c0eab74f19a30efe500cc63c0805d962ba60455114615c38cd0cc87"
},
"downloads": -1,
"filename": "postnl_sdk-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "524e20ff02ccd841bd20a1590c6e1077",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 57835,
"upload_time": "2024-04-18T09:31:30",
"upload_time_iso_8601": "2024-04-18T09:31:30.848597Z",
"url": "https://files.pythonhosted.org/packages/c0/08/4fc71b92528f81f0bfb8cc37886713a455d5b0751873aca584bc89638439/postnl_sdk-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 09:31:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "postnl-sdk"
}
