Skip to content

Commit 92ef962

Browse files
AlexandrosMoracampos1916Aleffio
authored
[PW-4392] Update README based on the new template (#140)
* Update README based on the new template * Update the endpoints versions * Add the api versions in the description * Add the example with xapi key * Apply suggestions from code review Co-authored-by: Ángel Campos <angel.campos@adyen.com> * Update README.md Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> Co-authored-by: Ángel Campos <angel.campos@adyen.com> Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com>
1 parent 995eaf5 commit 92ef962

File tree

1 file changed

+61
-44
lines changed

1 file changed

+61
-44
lines changed

README.md

Lines changed: 61 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,85 @@
11
[![Build Status](https://travis-ci.org/Adyen/adyen-python-api-library.svg?branch=master)](https://travis-ci.org/Adyen/adyen-python-api-library)
22
[![Coverage Status](https://coveralls.io/repos/github/Adyen/adyen-python-api-library/badge.svg?branch=master)](https://coveralls.io/github/Adyen/adyen-python-api-library?branch=master)
33

4-
# Adyen APIs Library for Python
5-
6-
This library simplifies working with Adyen APIs and allows you to integrate Adyen
7-
payments within any Python application.
8-
9-
## Integration
10-
The Library supports all APIs under the following services:
11-
12-
* checkout
13-
* checkout utility
14-
* payments
15-
* modifications
16-
* payouts
17-
* recurring
18-
19-
## Requirements
20-
4+
This is the officially supported Python library for using Adyen's APIs.
5+
## Integration
6+
The library supports all APIs under the following services:
7+
8+
* [Checkout API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/overview): Our latest integration for accepting online payments. Current supported version: **v67**
9+
* [Payments API](https://docs.adyen.com/api-explorer/#/Payment/v64/overview): Our classic integration for online payments. Current supported version: **v64**
10+
* [Recurring API](https://docs.adyen.com/api-explorer/#/Recurring/v49/overview): Endpoints for managing saved payment details. Current supported version: **v49**
11+
* [Payouts API](https://docs.adyen.com/api-explorer/#/Payout/v64/overview): Endpoints for sending funds to your customers. Current supported version: **v64**
12+
* [Orders API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/orders): Endpoints for creating and canceling orders. Current supported version: **v67**
13+
* [Utility API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/originKeys): This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. Current supported version: **v67**
14+
15+
For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
16+
17+
18+
## Prerequisites
19+
20+
- [Adyen test account](https://docs.adyen.com/get-started-with-adyen)
21+
- [API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). For testing, your API credential needs to have the [API PCI Payments role](https://docs.adyen.com/development-resources/api-credentials#roles).
2122
- Python 2.7 or 3.6
2223
- Packages: requests or pycurl ( optional )
23-
- Adyen account. If you don't have this you can request it here: https://www.adyen.com/home/discover/test-account-signup#form
24+
2425

25-
## Installation
26+
## Installation
2627

2728
### For development propose
2829

29-
Clone this repository and run ```make install```
30+
Clone this repository and run
31+
~~~~ bash
32+
make install
33+
~~~~
3034

3135
### For usage propose
3236

33-
Use pip command: ```pip install Adyen```
34-
35-
## Usage
36-
37-
Create a class instance of the 'Adyen' class.
38-
39-
```python
37+
Use pip command:
38+
~~~~ bash
39+
pip install Adyen
40+
~~~~
41+
42+
## Using the library
43+
44+
45+
### General use with API key
46+
47+
~~~~ python
4048
import Adyen
4149

4250
ady = Adyen.Adyen()
4351

44-
ady.payment.client.username = "webservice user name"
52+
ady.payment.client.xapikey = "YourXapikey"
4553
ady.payment.client.skin_code = "skin code for Hosted Payment pages"
4654
ady.payment.client.hmac = "HMAC key for skin code"
4755
ady.payment.client.platform = "test" # Environment to use the library in.
4856
ady.payment.client.merchant_account = "merchant account name from CA"
49-
ady.payment.client.password = "webservice user password"
50-
```
51-
52-
## Documentation
53-
* https://docs.adyen.com/developers/development-resources/libraries
54-
* https://docs.adyen.com/developers/checkout
57+
~~~~
58+
59+
### Example integration
60+
61+
For a closer look at how our Python library works, clone our [example integration](https://github.com/adyen-examples/adyen-python-online-payments). This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.
5562

56-
## Support
57-
If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420).
5863

5964
## Contributing
60-
We strongly encourage you to join us in contributing to this repository so everyone can benefit from:
61-
* New features and functionality
62-
* Resolved bug fixes and issues
63-
* Any general improvements
64-
65-
Read our [**contribution guidelines**](CONTRIBUTING.md) to find out how.
66-
65+
66+
We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements.
67+
68+
69+
Have a look at our [contributing guidelines](https://github.com/Adyen/adyen-python-api-library/blob/develop/CONTRIBUTING.md) to find out how to raise a pull request.
70+
71+
72+
## Support
73+
If you have a feature request, or spotted a bug or a technical problem, [create an issue here](https://github.com/Adyen/adyen-web/issues/new/choose).
74+
75+
For other questions, [contact our Support Team](https://www.adyen.help/hc/en-us/requests/new?ticket_form_id=360000705420).
76+
77+
6778
## Licence
68-
MIT license see LICENSE
79+
This repository is available under the [MIT license](https://github.com/Adyen/adyen-python-api-library/blob/master/LICENSE.md).
80+
81+
82+
## See also
83+
* [Example integration](https://github.com/adyen-examples/adyen-python-online-payments)
84+
* [Adyen docs](https://docs.adyen.com/)
85+
* [API Explorer](https://docs.adyen.com/api-explorer/)

0 commit comments

Comments
 (0)