# PAYONE Commerce Platform Python SDK
[](https://sonarcloud.io/summary/new_code?id=PAYONE-GmbH_PCP-ServerSDK-python)
[](https://sonarcloud.io/summary/new_code?id=PAYONE-GmbH_PCP-ServerSDK-python)
Welcome to the Python SDK for the PAYONE Commerce Platform! This repository contains a powerful, easy-to-use software development kit (SDK) designed to simplify the integration of online payment processing into your applications.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Error Handling](#error-handling)
- [Client Side](#client-side)
- [Apple Pay](#apple-pay)
- [Demo App](#demo-app)
- [Contributing](#contributing)
- [Build the library](#build-the-library)
- [Run tests](#run-tests)
- [Releasing the library](#releasing-the-library)
- [Preparing the Release](#preparing-the-release)
- [Changelog Generation with Conventional Changelog](#changelog-generation-with-conventional-changelog)
- [Merging the Release Branch](#merging-the-release-branch)
- [License](#license)
## Features
- **Easy Integration**: Seamlessly integrate online payment processing into your application.
- **Secure Transactions**: Built with security best practices to ensure safe transactions.
- **Extensive Documentation**: Detailed documentation to help you get started quickly.
- **Open Source**: Fully open source and community-driven.
## Installation
```sh
python3 -m pip install "pcp_serversdk_python"
```
## Usage
To use this SDK you need to construct a `CommunicatorConfiguration` which encapsulate everything needed to connect to the PAYONE Commerce Platform.
```python
from pcp_serversdk_python import CommunicatorConfiguration
API_KEY = os.environ['API_KEY']
API_SECRET = os.environ['API_SECRET']
communicatorConfiguration = CommunicatorConfiguration(API_KEY, API_SECRET, "https://api.preprod.commerce.payone.com")
```
With the configuration you can create an API client for each reource you want to interact with. For example to create a commerce case you can use the `CommerceCaseApiClient`.
```python
from pcp_serversdk_python import CommunicatorConfiguration, CheckoutApiClient
commerceCaseClient = CommerceCaseApiClient(communicatorConfiguration)
```
All payloads and reponses are availabe as java classes within the `com.payone.commerce.platform.lib.models.*` package. The serialization and deserialization is handled by the SDK internally. For example, to create an empty commerce case you can pass a `CreateCommerceCaseRequest` instance:
```python
createCommerceCaseRequest = CreateCommerceCaseRequest()
createCommerceCaseResponse = commerceCaseClient.createCommerceCaseRequest('merchant_id', createCommerceCaseRequest);
```
The models directly map to the API as described in [PAYONE Commerce Platform API Reference](https://docs.payone.com/pcp/commerce-platform-api). For an in depth example you can take a look at the [demo app](#demo-app).
### Error Handling
When making a request any client may throw a `ApiException`. There two subtypes of this exception:
- `ApiErrorReponseException`: This exception is thrown when the API returns an well-formed error response. The given errors are deserialized into `APIError` objects which are availble via the `getErrors()` method on the exception. They usually contain useful information about what is wrong in your request or the state of the resource.
- `ApiResponseRetrievalException`: This exception is a catch-all exception for any error that cannot be turned into a helpful error response. This includes malformed responses or unknown responses.
Network errors are not wrap, you can should handle the standard `IOExeption`.
### Client Side
For most [payment methods](https://docs.payone.com/pcp/commerce-platform-payment-methods) some information from the client is needed, e.g. payment information given by Apple when a payment via ApplePay suceeds. PAYONE provides client side SDKs which helps you interact the third party payment providers. You can find the SDKs under the [PAYONE GitHub organization](https://github.com/PAYONE-GmbH). Either way ensure to never store or even send credit card information to your server. The PAYONE Commerce Platform never needs access to the credit card information. The client side is responsible for safely retrieving a credit card token. This token must be used with this SDK.
### Apple Pay
When a client is successfully made a payment via ApplePay it receives a [ApplePayPayment](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment). This structure is accessible as the `ApplePayPayment` class. You can use the `ApplePayTransformer` to map an `ApplePayPayment` to a `MobilePaymentMethodSpecificInput` which can be used for payment executions or order requests. The transformer has a static method `transformApplePayPaymentToMobilePaymentMethodSpecificInput()` which takes an `ApplePayPayment` and returns a `MobilePaymentMethodSpecificInput`. The transformer does not check if the response is complete, if anything is missing the field will be set to `null`.
```python
# TODO
```
### Run the example app
```sh
API_KEY=api_key API_SECRET=api_secret MERCHANT_ID=123 COMMERCE_CASE_ID=234 CHECKOUT_ID=345 python3 example/main.py
```
## Contributing
We welcome contributions from the community. If you want to contribute, please follow these steps:
Fork the repository.
Create a new branch (`git checkout -b feature/feature-branch`).
Make your changes.
Commit your changes (`git commit -am 'feat: add new feature'`).
Push to the branch (`git push origin feature/feature-branch`).
Create a new Pull Request.
Please make sure to follow the coding standards and write appropriate tests for your changes.
### Build the library
```sh
# setup python environment
./scripts.sh setup
# install deps
./scripts.sh install
# build
./scripts.sh build
```
### Run tests
```sh
./scripts.sh test
```
### Releasing the library
#### Preparing the Release
- Checkout develop branch
- Create release branch (release/0.1.0)
```sh
git checkout -b release/0.1.0
```
- Run prepare-release.sh script to set correct version
```sh
./prepare-release.sh
```
#### Changelog Generation with Conventional Changelog
After calling the `prepare_release.sh` script, it is recommended to manually trigger the changelog generation script (which uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)).
1. **Conventional Commit Messages**:
- Ensure all commit messages follow the conventional commit format, which helps in automatic changelog generation.
- Commit messages should be in the format: `type(scope): subject`.
2. **Enforcing Commit Messages**:
- We enforce conventional commit messages using [Lefthook](https://github.com/evilmartians/lefthook) with [commitlint](https://github.com/conventional-changelog/commitlint).
- This setup ensures that all commit messages are validated before they are committed.
3. **Generate Changelog**:
- Run the changelog generation script to update the `CHANGELOG.md` file:
```sh
npm run changelog
```
- Review and commit the updated changelog before proceeding with the release.
#### Merging the Release Branch
- Create PR on develop branch
- Merge develop in main branch
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
---
Thank you for using our SDK for Online Payments! If you have any questions or need further assistance, feel free to open an issue or contact us.
Raw data
{
"_id": null,
"home_page": "https://github.com/PAYONE-GmbH/PCP-ServerSDK-python",
"name": "pcp-serversdk-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "payone, pcp, server, python, sdk",
"author": "PAYONE-GmbH",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/54/8d/43dc761317612cc447dd537a670f1d6cb504cb17fb221660ae25fad88b20/pcp_serversdk_python-0.0.3.tar.gz",
"platform": null,
"description": "# PAYONE Commerce Platform Python SDK\n\n[](https://sonarcloud.io/summary/new_code?id=PAYONE-GmbH_PCP-ServerSDK-python)\n[](https://sonarcloud.io/summary/new_code?id=PAYONE-GmbH_PCP-ServerSDK-python)\n\n\n\nWelcome to the Python SDK for the PAYONE Commerce Platform! This repository contains a powerful, easy-to-use software development kit (SDK) designed to simplify the integration of online payment processing into your applications.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n - [Error Handling](#error-handling)\n - [Client Side](#client-side)\n - [Apple Pay](#apple-pay)\n- [Demo App](#demo-app)\n- [Contributing](#contributing)\n - [Build the library](#build-the-library)\n - [Run tests](#run-tests)\n - [Releasing the library](#releasing-the-library)\n - [Preparing the Release](#preparing-the-release)\n - [Changelog Generation with Conventional Changelog](#changelog-generation-with-conventional-changelog)\n - [Merging the Release Branch](#merging-the-release-branch)\n- [License](#license)\n\n## Features\n\n- **Easy Integration**: Seamlessly integrate online payment processing into your application.\n- **Secure Transactions**: Built with security best practices to ensure safe transactions.\n- **Extensive Documentation**: Detailed documentation to help you get started quickly.\n- **Open Source**: Fully open source and community-driven.\n\n## Installation\n\n```sh\npython3 -m pip install \"pcp_serversdk_python\"\n```\n\n## Usage\n\nTo use this SDK you need to construct a `CommunicatorConfiguration` which encapsulate everything needed to connect to the PAYONE Commerce Platform.\n\n```python\nfrom pcp_serversdk_python import CommunicatorConfiguration\n\nAPI_KEY = os.environ['API_KEY']\nAPI_SECRET = os.environ['API_SECRET']\n\ncommunicatorConfiguration = CommunicatorConfiguration(API_KEY, API_SECRET, \"https://api.preprod.commerce.payone.com\")\n```\n\nWith the configuration you can create an API client for each reource you want to interact with. For example to create a commerce case you can use the `CommerceCaseApiClient`.\n\n```python\nfrom pcp_serversdk_python import CommunicatorConfiguration, CheckoutApiClient\n\ncommerceCaseClient = CommerceCaseApiClient(communicatorConfiguration)\n```\n\nAll payloads and reponses are availabe as java classes within the `com.payone.commerce.platform.lib.models.*` package. The serialization and deserialization is handled by the SDK internally. For example, to create an empty commerce case you can pass a `CreateCommerceCaseRequest` instance:\n\n```python\ncreateCommerceCaseRequest = CreateCommerceCaseRequest()\ncreateCommerceCaseResponse = commerceCaseClient.createCommerceCaseRequest('merchant_id', createCommerceCaseRequest);\n```\n\nThe models directly map to the API as described in [PAYONE Commerce Platform API Reference](https://docs.payone.com/pcp/commerce-platform-api). For an in depth example you can take a look at the [demo app](#demo-app).\n\n### Error Handling\n\nWhen making a request any client may throw a `ApiException`. There two subtypes of this exception:\n\n- `ApiErrorReponseException`: This exception is thrown when the API returns an well-formed error response. The given errors are deserialized into `APIError` objects which are availble via the `getErrors()` method on the exception. They usually contain useful information about what is wrong in your request or the state of the resource.\n- `ApiResponseRetrievalException`: This exception is a catch-all exception for any error that cannot be turned into a helpful error response. This includes malformed responses or unknown responses.\n\nNetwork errors are not wrap, you can should handle the standard `IOExeption`.\n\n### Client Side\n\nFor most [payment methods](https://docs.payone.com/pcp/commerce-platform-payment-methods) some information from the client is needed, e.g. payment information given by Apple when a payment via ApplePay suceeds. PAYONE provides client side SDKs which helps you interact the third party payment providers. You can find the SDKs under the [PAYONE GitHub organization](https://github.com/PAYONE-GmbH). Either way ensure to never store or even send credit card information to your server. The PAYONE Commerce Platform never needs access to the credit card information. The client side is responsible for safely retrieving a credit card token. This token must be used with this SDK.\n\n### Apple Pay\n\nWhen a client is successfully made a payment via ApplePay it receives a [ApplePayPayment](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment). This structure is accessible as the `ApplePayPayment` class. You can use the `ApplePayTransformer` to map an `ApplePayPayment` to a `MobilePaymentMethodSpecificInput` which can be used for payment executions or order requests. The transformer has a static method `transformApplePayPaymentToMobilePaymentMethodSpecificInput()` which takes an `ApplePayPayment` and returns a `MobilePaymentMethodSpecificInput`. The transformer does not check if the response is complete, if anything is missing the field will be set to `null`.\n\n```python\n# TODO\n```\n\n### Run the example app\n\n```sh\nAPI_KEY=api_key API_SECRET=api_secret MERCHANT_ID=123 COMMERCE_CASE_ID=234 CHECKOUT_ID=345 python3 example/main.py\n```\n\n## Contributing\n\nWe welcome contributions from the community. If you want to contribute, please follow these steps:\n\nFork the repository.\nCreate a new branch (`git checkout -b feature/feature-branch`).\nMake your changes.\nCommit your changes (`git commit -am 'feat: add new feature'`).\nPush to the branch (`git push origin feature/feature-branch`).\nCreate a new Pull Request.\nPlease make sure to follow the coding standards and write appropriate tests for your changes.\n\n### Build the library\n\n```sh\n# setup python environment\n./scripts.sh setup\n# install deps\n./scripts.sh install\n# build\n./scripts.sh build\n```\n\n### Run tests\n\n```sh\n./scripts.sh test\n```\n\n### Releasing the library\n\n#### Preparing the Release\n\n- Checkout develop branch\n- Create release branch (release/0.1.0)\n\n```sh\ngit checkout -b release/0.1.0\n```\n\n- Run prepare-release.sh script to set correct version\n\n```sh\n./prepare-release.sh\n```\n\n#### Changelog Generation with Conventional Changelog\n\nAfter calling the `prepare_release.sh` script, it is recommended to manually trigger the changelog generation script (which uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)).\n\n1. **Conventional Commit Messages**:\n\n - Ensure all commit messages follow the conventional commit format, which helps in automatic changelog generation.\n - Commit messages should be in the format: `type(scope): subject`.\n\n2. **Enforcing Commit Messages**:\n\n - We enforce conventional commit messages using [Lefthook](https://github.com/evilmartians/lefthook) with [commitlint](https://github.com/conventional-changelog/commitlint).\n - This setup ensures that all commit messages are validated before they are committed.\n\n3. **Generate Changelog**:\n - Run the changelog generation script to update the `CHANGELOG.md` file:\n ```sh\n npm run changelog\n ```\n - Review and commit the updated changelog before proceeding with the release.\n\n#### Merging the Release Branch\n\n- Create PR on develop branch\n- Merge develop in main branch\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n\n---\n\nThank you for using our SDK for Online Payments! If you have any questions or need further assistance, feel free to open an issue or contact us.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/PAYONE-GmbH/PCP-ServerSDK-python"
},
"split_keywords": [
"payone",
" pcp",
" server",
" python",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e49fbfcb56a12a764e256d57f2f90672cb0ab177ac28a593048ba0a977f285b",
"md5": "650790ea3785759406a5f54d9a091d9c",
"sha256": "792674e93dc0da2a14e426ef4d822a75d22920eab8051658c11d27ee4c1222a2"
},
"downloads": -1,
"filename": "pcp_serversdk_python-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "650790ea3785759406a5f54d9a091d9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 90097,
"upload_time": "2024-08-21T10:23:39",
"upload_time_iso_8601": "2024-08-21T10:23:39.827182Z",
"url": "https://files.pythonhosted.org/packages/1e/49/fbfcb56a12a764e256d57f2f90672cb0ab177ac28a593048ba0a977f285b/pcp_serversdk_python-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "548d43dc761317612cc447dd537a670f1d6cb504cb17fb221660ae25fad88b20",
"md5": "a66ca9bb4f52a02797e5a28c1224d40f",
"sha256": "258734d64a7a5f1ba5c9a174473ef1ae677a74c99668583ebf36a3a649a904c8"
},
"downloads": -1,
"filename": "pcp_serversdk_python-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a66ca9bb4f52a02797e5a28c1224d40f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 37941,
"upload_time": "2024-08-21T10:23:41",
"upload_time_iso_8601": "2024-08-21T10:23:41.145873Z",
"url": "https://files.pythonhosted.org/packages/54/8d/43dc761317612cc447dd537a670f1d6cb504cb17fb221660ae25fad88b20/pcp_serversdk_python-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 10:23:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PAYONE-GmbH",
"github_project": "PCP-ServerSDK-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pcp-serversdk-python"
}
JSON
