Page Comparison

...

1. Follow the tutorial Subscribe to and Invoke an API to deploy the sample API, subscribe to it, and then generate keys.

   Info
   title Access Token
   Once you generate the keys, copy the access token. You can use this token to invoke APIs that you subscribe to using the same application.

2. Go to the API Store, click on the PhoneVerification API, and then click the SDKs tab.
   
   You will see the available client-side SDKs.

3. Click java to download the java SDK of the PhoneVerification API as a ZIP file. This downloads the PhoneVerification_1.0.0_java.zip file.

   Tip
   When you download an SDK, you will see that the file name includes the API name, version, and language of the SDK.

4. Unzip the PhoneVerification_1.0.0_java.zip file. Once you unzip the file, you will see a directory structure similar to the following:

   Expand
   title Click here to see the directory structure of the unzipped file
   Code Block PhoneVerification_1.0.0_java ├── build.gradle ├── build.sbt ├── docs │ ├── DefaultApi.md │ └── Payload.md ├── git_push.sh ├── gradle │ └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew ├── gradlew.bat ├── pom.xml ├── README.md ├── settings.gradle └── src ├── main │ ├── AndroidManifest.xml │ └── java │ └── org │ └── wso2 │ └── client │ ├── api │ │ ├── ApiCallback.java │ │ ├── ApiClient.java │ │ ├── ApiException.java │ │ ├── ApiResponse.java │ │ ├── auth │ │ │ ├── ApiKeyAuth.java │ │ │ ├── Authentication.java │ │ │ ├── HttpBasicAuth.java │ │ │ ├── OAuthFlow.java │ │ │ └── OAuth.java │ │ ├── Configuration.java │ │ ├── GzipRequestInterceptor.java │ │ ├── JSON.java │ │ ├── Pair.java │ │ ├── PhoneVerification │ │ │ └── DefaultApi.java │ │ ├── ProgressRequestBody.java │ │ ├── ProgressResponseBody.java │ │ └── StringUtil.java │ └── model │ └── PhoneVerification │ └── Payload.java └── test └── java └── org └── wso2 └── client └── api └── PhoneVerification └── DefaultApiTest.java

5. Use Maven to build the SDK. For detailed information, see Building a Project with Maven.
   Once you build the SDK, you can include the SDK as a dependency in your software project. For details on the Maven dependency, take a look at the README.md file.

   Code Block
   title Maven dependency collapse true
   <dependency> <groupId>org.wso2</groupId> <artifactId>org.wso2.client.PhoneVerification</artifactId> <version>1.0.0</version> <scope>compile</scope> </dependency>

   Info
   title Build using maven
   You can build the SDK using the mvn clean install command inside the root directory. For more information see Maven Start Guide.

6. After creating a maven project, import the following with respect to the SDK. These classes will be accessible from the code once the SDK is built using maven and will be included as maven dependencies in the project.

   Code Block
   import org.wso2.client.api.*; import org.wso2.client.api.auth.*; import org.wso2.client.model.PhoneVerification.*; import org.wso2.client.api.PhoneVerification.DefaultApi;

7. Create an instance of the DefaultApi object in the java code. This instance is necessary to get the API client, whch which handles the operations related to consuming the API, using the resources of the API.

   Code Block
   DefaultApi defaultApi = new DefaultApi();

8. Use the API client of the DefaultApi object instance to set HTTP request headers with required data. The HTTP request header might differ from one API to another depending on the implementation of the API. Following is a sample:

   Code Block
   ApiClient apiClient = defaultApi.getApiClient(); apiClient.addDefaultHeader("Accept", "application/json");

9. Include the access token as a header in the API client object as follows to invoke the API:

   Code Block
   String accessToken = "bc392b16-6ce2-3208-9023-8938fbc376ea"; apiClient.addDefaultHeader("Authorization", "Bearer " + accessToken);

   Warning
   You need an access token to invoke the API. It is important to have a valid subscription to obtain an access token before using the SDK. Note that the obtained access token has an expiration time.

10. Set the base path to the API client. 

    Code Block
    apiClient.setBasePath("https://gateway.api.cloud.wso2.com/t/testorg/phoneverify/1.0.0")

    The base path for the client application is the production (or sandbox) URL of the API, which you see in the Overview tab of the API.

11. Once the ApiClient object has all the required data, set the ApiClient for the instance of the DefaultApi object.

    Code Block
    defaultApi.setApiClient(apiClient);

12. Call the available function in the SDK to get the response from the API.

...