Building the API client library requires Maven to be installed.
To install the API client library to your local Maven repository, simply execute:
mvn install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deploy
Refer to the official documentation for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-java-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "io.swagger:swagger-java-client:1.0.0"
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/swagger-java-client-1.0.0.jar
- target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;
import java.io.File;
import java.util.*;
public class AuthApiExample {
public static void main(String[] args) {
AuthApi apiInstance = new AuthApi();
String customerid = "customerid_example"; // String | The Customer ID
try {
ApiKeyResponse result = apiInstance.keySecret(customerid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthApi#keySecret");
e.printStackTrace();
}
}
}
All URIs are relative to https://api.thesmsworks.co.uk/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AuthApi | keySecret | GET /auth/getApiKey | |
AuthApi | login | POST /auth/token | |
BatchMessagesApi | cancelScheduledBatchJob | DELETE /batches/schedule/{batchid} | |
BatchMessagesApi | getBatchById | GET /batch/{batchid} | |
BatchMessagesApi | scheduleBatch | POST /batch/schedule | |
BatchMessagesApi | sendBatch | POST /batch/send | |
MessagesApi | cancelScheduledJob | DELETE /messages/schedule/{messageid} | |
MessagesApi | getInboxMessages | POST /messages/inbox | |
MessagesApi | getMessageById | GET /messages/{messageid} | |
MessagesApi | getMessages | POST /messages | |
MessagesApi | scheduleMessage | POST /message/schedule | |
MessagesApi | sendMessage | POST /message/send | |
UtilsApi | test | GET /utils/test |
- ApiKeyResponse
- BatchMessage
- BatchMessageResponse
- CancelledMessageResponse
- ErrorModel
- Login
- Message
- MessageMetadata
- MessageResponse
- MessageResponseFailurereason
- MessagesResponse
- MessagesResponseMessages
- MetaData
- Query
- QueryMetadata
- ScheduledBatchResponse
- ScheduledMessageResponse
- SendMessageResponse
- TestResponse
- TokenResponse
- ExtendedErrorModel
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.