Skip to content

Commit e425334

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

File tree

1 file changed

+8
-29
lines changed

1 file changed

+8
-29
lines changed

README.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88

99
## Requirements
10-
1110
* Python 2.7 or greater
1211
* OpenSSL 1.0.2 or greater
1312
* An Authorize.Net account (see _Registration & Configuration_ section below)
@@ -19,38 +18,30 @@ The Authorize.Net APIs only support connections using the TLS 1.2 security proto
1918

2019

2120
## Installation
22-
2321
To install the AuthorizeNet Python SDK:
2422

2523
`pip install authorizenet`
2624

2725

2826
## Registration & Configuration
29-
3027
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.
3128
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/).
3229

33-
3430
### Authentication
35-
3631
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).
3732

3833
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.
3934

40-
4135
#### To set your API credentials for an API request:
42-
4336
```python
4437
merchantAuth = apicontractsv1.merchantAuthenticationType()
4538
merchantAuth.name = 'YOUR_API_LOGIN_ID'
4639
merchantAuth.transactionKey = 'YOUR_TRANSACTION_KEY'
4740
```
4841

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.
50-
42+
You should never include your Login ID and Transaction Key directly in a 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.
5143

5244
### Switching between the sandbox environment and the production environment
53-
5445
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:
5546
```python
5647
# For PRODUCTION use
@@ -72,39 +63,27 @@ Additionally, you can find details and examples of how our API is structured in
7263
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.
7364

7465

66+
## Building & Testing the SDK
7567

76-
77-
78-
79-
80-
81-
82-
83-
84-
85-
## Building and Testing Source Code
86-
87-
Requirements
88-
--------------------------------------
68+
### Requirements
8969
- python 2.7
9070
- pyxb 1.2.4
9171

92-
9372
Run the following to get pyxb and nosetests:
9473
- pip install pyxb
9574
- pip install unittest2
9675
- pip install nose
9776
- pip install lxml
9877

99-
Testing
100-
--------------------------------------
78+
### Running the SDK Tests
10179
- Tests available are: unit tests, mock tests, sample code
10280
- use nosetests to run all unittests
10381

10482
`>nosetests`
10583

84+
### Testing Guide
85+
For additional help in testing your own code, Authorize.Net maintains a [comprehensive testing guide](http://developer.authorize.net/hello_world/testing_guide/) that includes test credit card numbers to use and special triggers to generate certain responses from the sandbox environment.
10686

107-
## License
108-
109-
This repository is destributed under a proprietary license. See the provided [`LICENSE.txt`](/license.txt) file.
11087

88+
## License
89+
This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/license.txt) file.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy