Skip to content

Commit da5e5ee

Browse files
committed
standardize readme format and info across repos
1 parent 717440e commit da5e5ee

File tree

2 files changed

+43
-11
lines changed

2 files changed

+43
-11
lines changed

README.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
* OpenSSL 1.0.2 or greater
1313
* An Authorize.Net account (see _Registration & Configuration_ section below)
1414

15+
_Note: Our goal is ensuring this SDK is compatible with Python 2.7+, 3.2+ and PyPy, but at the moment we're primarily testing against Python 2.7._
1516

16-
_Note: We'll ultimately by ensuring this SDK is compatible with Python 2.7+, 3.2+ and PyPy, but at the moment we're primarily testing against Python 2.7._
17+
### TLS 1.2
18+
The Authorize.Net APIs only support connections using the TLS 1.2 security protocol. It's important to make sure you have new enough versions of all required components to support TLS 1.2. Additionally, it's very important to keep these components up to date going forward to mitigate the risk of any security flaws that may be discovered in your system or any libraries it uses.
1719

1820

1921
## Installation
@@ -25,30 +27,60 @@ To install the AuthorizeNet Python SDK:
2527

2628
## Registration & Configuration
2729

28-
Use of this SDK and the Authorize.Net APIs requires having an account on our system
29-
Get a sandbox account at https://developer.authorize.net/sandbox
30+
Use of this SDK and the Authorize.Net APIs requires having an account on our system. You can find these details in the Settings section.
31+
If you don't currently have a production Authorize.Net account and need a sandbox account for testing, you can easily sign up for one [here](https://developer.authorize.net/sandbox/).
3032

3133

3234
### Authentication
3335

34-
Set your API credentials:
36+
To authenticate with the Authorize.Net API you will need to use your account's API Login ID and Transaction Key. If you don't have these values, you can obtain them from our Merchant Interface site. Access the Merchant Interface for production accounts at (https://account.authorize.net/) or sandbox accounts at (https://sandbox.authorize.net).
37+
38+
Once you have your keys simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
39+
40+
41+
#### To set your API credentials for an API request:
3542

3643
```python
3744
merchantAuth = apicontractsv1.merchantAuthenticationType()
3845
merchantAuth.name = 'YOUR_API_LOGIN_ID'
3946
merchantAuth.transactionKey = 'YOUR_TRANSACTION_KEY'
4047
```
4148

49+
You should never include your Login ID and Transaction Key directly in a PHP file that's in a publically accessible portion of your website. A better practice would be to define these in a constants file, and then reference those constants in the appropriate place in your code.
4250

43-
### Setting Production or Sandbox Environments
44-
To set the environment use the setenvironment method on the controller before executing. E.g. for the example above:
51+
52+
### Switching between the sandbox environment and the production environment
53+
54+
Authorize.Net maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, use the `setenvironment` method on the controller before executing. For example:
4555
```python
46-
# Defaults to constants.SANDBOX for sandbox testing
47-
createtransactioncontroller.setenvironment(constants.PRODUCTION)
56+
# For PRODUCTION use
57+
createtransactioncontroller.setenvironment(constants.PRODUCTION)
4858
```
4959

50-
## Usage
51-
See our sample code repository at https://github.com/AuthorizeNet/sample-code-python
60+
API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.
61+
62+
63+
## SDK Usage Examples and Sample Code
64+
To get started using this SDK, it's highly recommended to download our sample code repository:
65+
* [Authorize.Net Python Sample Code Repository (on GitHub)](https://github.com/AuthorizeNet/sample-code-python)
66+
67+
In that respository, we have comprehensive sample code for all common uses of our API:
68+
69+
Additionally, you can find details and examples of how our API is structured in our API Reference Guide:
70+
* [Developer Center API Reference](http://developer.authorize.net/api/reference/index.html)
71+
72+
The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.
73+
74+
75+
76+
77+
78+
79+
80+
81+
82+
83+
5284

5385
## Building and Testing Source Code
5486

sample-code-python

Submodule sample-code-python updated 67 files

0 commit comments

Comments
 (0)