Skip to content

Commit 41bc28b

Browse files
committed
standardize readme format and info across repos
1 parent 8813f29 commit 41bc28b

File tree

2 files changed

+68
-18
lines changed

2 files changed

+68
-18
lines changed

README.md

Lines changed: 67 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Authorize.Net Java SDK
2-
======================
1+
# Authorize.Net Java SDK
2+
33
[![Travis](https://img.shields.io/travis/AuthorizeNet/sdk-java/master.svg)](https://travis-ci.org/AuthorizeNet/sdk-java)
44
[![Code Climate](https://codeclimate.com/github/AuthorizeNet/sdk-java/badges/gpa.svg)](https://codeclimate.com/github/AuthorizeNet/sdk-java)
55
[![Maven Central](https://img.shields.io/maven-central/v/net.authorize/anet-java-sdk.svg?style=flat)](http://mvnrepository.com/artifact/net.authorize/anet-java-sdk)
@@ -9,21 +9,67 @@ Authorize.Net Java SDK
99
<artifactId>anet-java-sdk</artifactId>
1010
<version>LATEST</version>
1111
```
12-
13-
Prerequisites
14-
=============
1512

16-
* JDK 1.5.0 or higher
17-
* Ant 1.6.2 or higher (build SDK only)
18-
* Maven 2.2.0 or higher (build SDK only)
13+
14+
## Requirements
15+
16+
* JDK 1.5.0 or higher
17+
* Ant 1.6.2 or higher (build SDK only)
18+
* Maven 2.2.0 or higher (build SDK only)
19+
* An Authorize.Net account (see _Registration & Configuration_ section below)
20+
21+
_Note: Support for building the SDK with either Ant or Maven has been made. Please see the respective build processes below. All initial jars and docs were built with Ant, however._
22+
23+
### TLS 1.2
24+
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.
25+
26+
27+
## Installation
28+
29+
30+
## Registration & Configuration
31+
32+
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.
33+
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/).
34+
35+
### Authentication
36+
37+
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).
38+
39+
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.
40+
41+
#### To set your API credentials for an API request:
42+
43+
44+
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.
45+
46+
### Switching between the sandbox environment and the production environment
47+
48+
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, do the following:
49+
```java
50+
// For PRODUCTION use
51+
```
52+
53+
API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.
54+
55+
56+
## SDK Usage Examples and Sample Code
57+
To get started using this SDK, it's highly recommended to download our sample code repository:
58+
* [Authorize.Net Java Sample Code Repository (on GitHub)](https://github.com/AuthorizeNet/sample-code-java)
59+
60+
In that respository, we have comprehensive sample code for all common uses of our API:
61+
62+
Additionally, you can find details and examples of how our API is structured in our API Reference Guide:
63+
* [Developer Center API Reference](http://developer.authorize.net/api/reference/index.html)
1964

20-
Note: Support for building the SDK with either Ant or Maven has been made.
21-
Please see the respective build processes below. All initial jars
22-
and docs were built with Ant however.
65+
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.
2366

2467

25-
Dependencies
26-
============
68+
69+
70+
## Wot's all this, then?
71+
72+
### Dependencies
2773

2874
* commons-logging-1.1.1.jar : logging
2975
* log4j-1.2.16.jar : logging
@@ -34,8 +80,7 @@ Dependencies
3480
* hamcrest-library-1.3.jar : unit testing
3581
* jmock-2.6.0.jar : unit testing
3682

37-
Build process
38-
==============
83+
### Build process
3984

4085
* Note: To properly run the unit tests, please reference the
4186
anet-java-sdk.properties file, which is a simple properties file that
@@ -68,9 +113,14 @@ Build process
68113

69114
$ ant javadoc
70115

71-
Sample Code
72-
===========
116+
## Sample Code
117+
73118
There are some sample unit tests that are located in the test directory. They
74119
can demonstrate basic functionality. However, detailed sample code for all
75120
of the API operations available can be found in our sample code repository
76121
at https://github.com/AuthorizeNet/sample-code-java
122+
123+
124+
## License
125+
126+
This repository is destributed under a proprietary license. See the provided [`LICENSE.txt`](/license.txt) file.

sample-code-java

Submodule sample-code-java updated 68 files

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