Whispir's SDK allows Java Developers to get up and running with Whispir's API quickly.
Follow the instructions below to include the dependencies in your project.
If you've got any questions feel free to tweet us at @jordwalsh or @msanj2ev.
Users can easily include the Whispir dependency in their projects using Maven.
The dependency information is as follows:
<dependency>
<groupId>com.whispir</groupId>
<artifactId>sdk</artifactId>
<version>2.3.0</version>
</dependency>See the examples section below for usage instructions.
Whispir's SDK is built using Maven. To create the JAR files, simply execute the install maven target (skip tests unless you want to add the static parameters in the tests file first).
mvn clean install -DskipTests=trueThis will produce two JAR fies:
/target/WhispirSDK-2.2.2-with-dependencies.jar
/target/WhispirSDK.jarThe JAR with dependencies should be used as a standalone import into any project.
If you are using other Apache HTTP Client libraries, the WhispirSDK.jar may suit your project better, so import that with your other HTTP Client libraries.
Note, you will need GPG installed to sign the libraries. This is included by default within the pom.xml file.
If you want to build from source but don't want to install gpg, then remove the following code from line 59 in the pom.xml:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.5</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>The API can perform three activities at the moment:
- Sending messages
- Retrieving Workspaces
- Sending scenarios
These are described below:
package com.whispir.sdk.examples;
import java.util.Map;
import java.util.TreeMap;
import com.whispir.sdk.WhispirEndPoints;
import com.whispir.sdk.WhispirResponse;
import com.whispir.sdk.WhispirSDK;
import com.whispir.sdk.exceptions.WhispirSDKException;
public class SDKExample {
//APIKEY, Username and Password available from whispir.io
public static final String API_KEY = "...";
public static final String USERNAME = "...";
public static final String PASSWORD = "...";
public static final WhispirEndPoints APIENDPOINT = WhispirEndPoints.AU;
public static void main(String[] args) {
try {
// INIT API object
WhispirSDK sdk = new WhispirSDK(API_KEY, USERNAME, PASSWORD, APIENDPOINT);
// Send the message
WhispirResponse response = sdk.sendMessage("61400000000",
"This is the subject of my SMS",
"This is the content of my SMS");
// Status should be 202 Accepted
System.out.println("Status: " + response.getStatusCode());
//------------------------------------------------------
// Retrieve a list of workspaces
WhispirResponse workspaceResponse = sdk.getWorkspaces();
TreeMap<String, String> workspaces = (TreeMap<String, String>) workspaceResponse
.getResponse();
// Iterate through the workspaces, printing the names and IDs out
for (Map.Entry<String, String> entry : workspaces.entrySet()) {
String workspaceName = entry.getKey();
String workspaceId = entry.getValue();
System.out.println(workspaceName + " => " + workspaceId);
}
//------------------------------------------------------
//Retrieve a list of scenarios
WhispirResponse scenariosResponse = sdk.getScenarios();
TreeMap<String, String> scenarios = (TreeMap<String, String>) scenariosResponse
.getResponse();
// Iterate through the workspaces, printing the names and IDs out
for (Map.Entry<String, String> entry : scenarios.entrySet()) {
String scenarioName = entry.getKey();
String scenarioId = entry.getValue();
System.out.println(scenarioName + " => " + scenarioId);
}
//execute the scenario
String scenarioId = "...";
String workspaceId = "...";
status = sdk.sendScenario(workspaceId, scenarioId);
// Status should be 202 Accepted
System.out.println("Status: " + status);
} catch (WhispirSDKException e) {
e.printStackTrace();
}
}
}This SDK is provided for use within your projects to simplify the use of Whispir's API.
The support of this code (and any potential bugs within) is not included under the SLA or contractual obligations within customers agreements with Whispir.
Whispir will provide a best effort to ensure this repository is bug free.
Please submit any issues via GitHub, or alternatively, fix the code and submit a pull request.
See the LICENSE.txt and refer to Whispir's Terms of Service.
- Updated the SDK to handle the API gateway changes. You would now be able to connect to the regional api gateways
- Upgraded pom.xml; org.apache.httpcomponents:httpclient to now use version 4.3.6 or later to fix the vulnerability described in CVE-2015-5262
- Fixed a bug with DNS lookup when debugHost was being used to specify a non-production host. This is only relevant for customers doing testing in a sandbox environment.
- Added support for AuthCache when making connections through proxy. This was causing duplicate requests.
- Refactored some of the tests to utlise workspaces.
Installation steps updated to reference Maven dependency instead of building from source.
- Added getSingleMessage and getSingleWorkspace functions
- Refactored some of the tests to make them run when no Test Workspace has been defined
- Support for Basic Proxy Authentication (thanks to a pull request by vlsinitsyn)
- Support for Creating Scenarios
- Support for Creating Workspaces
- I changed the default response type to WhispirResponse from int for POST requests. This was because I needed to get the header information for managing Scenarios and it's just a generally cleaner approach.
- Currently, you can't create a Scenario in the default workspace, you need to specify a workspace ID. This is due to a bug in Whispir that will be fixed in an upcoming release.
- After creating workspaces via the API, a login to Whispir is required. This rebuilds the cache and allows the workspace to be used. A subseqent release of Whispir will resolve this issue.