Skip to content

Commit 75868b9

Browse files
authored
Improved formatting for README content
1 parent b99e79e commit 75868b9

File tree

1 file changed

+57
-37
lines changed

1 file changed

+57
-37
lines changed

README.md

Lines changed: 57 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,75 +12,95 @@ Java 1.8.
1212

1313
* Maven Dependency:
1414

15-
```xml
16-
<dependency>
17-
<groupId>com.cybersource</groupId>
18-
<artifactId>cybersource-rest-client-java</artifactId>
19-
<version>0.0.4</version>
20-
</dependency>
21-
```
15+
```xml
16+
<dependency>
17+
<groupId>com.cybersource</groupId>
18+
<artifactId>cybersource-rest-client-java</artifactId>
19+
<version>0.0.4</version>
20+
</dependency>
21+
```
22+
2223
* Gradle Dependency
23-
````
24-
dependencies {
25-
compile 'com.cybersource:cybersource-rest-client-java:0.0.4'
26-
}
27-
````
24+
25+
````gradle
26+
dependencies {
27+
compile 'com.cybersource:cybersource-rest-client-java:0.0.4'
28+
}
29+
````
2830

2931
## Registration & Configuration
30-
Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys [here](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
3132

32-
Remember this SDK is for use in server-side Java applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.
33+
Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys [here](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html).
3334

35+
Remember this SDK is for use in server-side Java applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.
3436

3537
## SDK Usage Examples and Sample Code
36-
To get started using this SDK, it's highly recommended to download our sample code repository:
38+
39+
To get started using this SDK, it is highly recommended to download our sample code repository:
40+
3741
* [Cybersource Java Sample Code Repository (on GitHub)](https://github.com/CyberSource/cybersource-rest-samples-java)
3842

3943
In that respository, we have comprehensive sample code for all common uses of our API:
4044

4145
Additionally, you can find details and examples of how our API is structured in our API Reference Guide:
46+
4247
* [Developer Center API Reference](https://developer.cybersource.com/api/reference/api-reference.html)
4348

4449
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.
4550

4651
## MetaKey Support
47-
Meta Key is a key generated by an entity that can be used to authenticate on behalf of other entities provided that the entity which holds key is a parent entity or associated as a partner.
52+
53+
A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.
54+
55+
The Portfolio or Parent Account owns the key and is considered the transaction submitter when a Meta Key is used, while the merchant owns the transaction.
56+
57+
MIDs continue to be able to create keys for themselves, even if a Meta Key is generated.
58+
59+
Further information on MetaKey can be found in [New Business Center User Guide](https://developer.cybersource.com/library/documentation/dev_guides/Business_Center/New_Business_Center_User_Guide.pdf).
4860

4961
## OAuth Support
50-
The CyberSource OAuth2.0 Authorization Server (or API Auth Service) will issue access tokens (based on merchant user credentials) to CyberSource or third-party Applications. These applications can access CyberSource API's on the merchant's behalf, using the access tokens.
51-
During application registration, third-party application developers are issued a client_id and optionally a client_secret (if they can be considered a confidential client, for example a web application). Requesting an access token is fairly straightforward: Use the CyberSource token URL and include a set of form-urlencoded parameters.
52-
For more detailed information on OAuth, refer to the link - https://developer.cybersource.com/api/developer-guides/OAuth/cybs_extend_intro.html
5362

54-
Set the run environment to OAuth enabled URLs. OAuth only works in these run environments.
55-
```
56-
// For TESTING use
57-
props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.SANDBOX");
58-
// For PRODUCTION use
59-
//props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.PRODUCTION");
63+
OAuth enables service providers to securely share access to customer data without sharing password data.
64+
65+
The CyberSource OAuth2.0 Authorization Server (or API Auth Service) will issue access tokens (based on merchant user credentials) to CyberSource or third-party Applications. These applications can access CyberSource APIs on the merchant's behalf, using the access tokens.
66+
67+
During application registration, third-party application developers are issued a `client_id` and optionally a `client_secret` (if they can be considered a confidential client, for example a web application).
68+
69+
These values will be used when the merchant application wants to request an access token and/or a refresh token. This is explained in more detail in [Requesting the Access and Refresh Tokens](https://developer.cybersource.com/api/developer-guides/OAuth/cybs_extend_intro/obtaining_access_refresh_tokens.html).
70+
71+
For more detailed information on OAuth, refer to the documentation at [Cybersource OAuth 2.0](https://developer.cybersource.com/api/developer-guides/OAuth/cybs_extend_intro.html).
72+
73+
In order to use OAuth, set the run environment to OAuth enabled URLs. OAuth only works in these run environments.
74+
75+
```java
76+
// For TESTING use
77+
props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.SANDBOX");
78+
// For PRODUCTION use
79+
//props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.PRODUCTION");
6080
```
6181

6282
### Switching between the sandbox environment and the production environment
63-
Cybersource 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, set the `runEnvironment` property in the SDK Configuration. See our sample at https://github.com/CyberSource/cybersource-rest-samples-java/blob/master/src/main/java/Data/Configuration.java.
83+
84+
Cybersource 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, set the `runEnvironment` property in the SDK Configuration. See our sample at <https://github.com/CyberSource/cybersource-rest-samples-java/blob/master/src/main/java/Data/Configuration.java>.
6485

6586
```java
66-
// For TESTING use
67-
props.setProperty("runEnvironment", "CyberSource.Environment.SANDBOX");
68-
// For PRODUCTION use
69-
//props.setProperty("runEnvironment", "CyberSource.Environment.PRODUCTION");
87+
// For TESTING use
88+
props.setProperty("runEnvironment", "CyberSource.Environment.SANDBOX");
89+
// For PRODUCTION use
90+
//props.setProperty("runEnvironment", "CyberSource.Environment.PRODUCTION");
7091
```
7192

7293
To Use OAuth, use OAuth enabled URLs
7394

74-
```
75-
// For TESTING use
76-
props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.SANDBOX");
77-
// For PRODUCTION use
78-
//props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.PRODUCTION");
95+
```java
96+
// For TESTING use
97+
props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.SANDBOX");
98+
// For PRODUCTION use
99+
//props.setProperty("runEnvironment", "CyberSource.Environment.MutualAuth.PRODUCTION");
79100
```
80101

81102
API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.
82103

83-
84-
85104
## License
105+
86106
This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/LICENSE.txt) file.

0 commit comments

Comments
 (0)