This project contains a set of samples that you can explore to understand what the REST APIs can do for you. The sample comes pre-configured with a test account but in case you need to try them against your account, you must obtain your client id and client secret from the developer portal.
- Simply run
./gradlew clean jettyRunto start jetty server. - Access
http://localhost:<jetty-port>/rest-api-sample/in your browser to view samples.
- Test Client ID and Client Secret can be found in the file sdk_config.properties file under src/main/resources/ folder.
- The endpoint URL for token generation and API calls are fetched from sdk_config.properties file under src/main/resources/ folder.
- AccessToken are generated once using GenerateAccessToken.java and used for the samples.
- Obtain the redirect URL as shown below:
// Initialize apiContext with proper credentials and environment.
APIContext context = new APIContext(clientID, clientSecret, "sandbox");
List<String> scopes = new ArrayList<String>() {{
/**
* 'openid'
* 'profile'
* 'address'
* 'email'
* 'phone'
* 'https://uri.paypal.com/services/paypalattributes'
* 'https://uri.paypal.com/services/expresscheckout'
* 'https://uri.paypal.com/services/invoicing'
*/
add("openid");
add("profile");
add("email");
}};
String redirectUrl = Session.getRedirectURL("UserConsent", scopes, context);
System.out.println(redirectUrl);- Capture the authorization code that is available as a query parameter (
code) in the redirect url. - Exchange the authorization code for an access token or refresh token.
// Initialize apiContext with proper credentials and environment.
APIContext context = new APIContext(clientID, clientSecret, "sandbox");
// Replace the code with the code value returned from the redirect on previous step.
Tokeninfo info = Tokeninfo.createFromAuthorizationCode(context, code);
String accessToken = info.getAccessToken();
String refreshToken = info.getRefreshToken();- The refresh token received can be stored permanently in your database, and reused later for fetching user information, or for third party invoicing (with proper scopes).
- The refresh token can be used to retrieve user information as shown below:
// Initialize apiContext with proper credentials and environment. Also, set the refreshToken retrieved from previous step.
APIContext userAPIContext = new APIContext(clientID, clientSecret, "sandbox").setRefreshToken(info.getRefreshToken());
Userinfo userinfo = Userinfo.getUserinfo(userAPIContext);
System.out.println(userinfo);