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>axxell-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "io.swagger:axxell-client:1.0.0"
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/axxell-client-1.0.0.jar
- target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import com.cinaq.axxell.client.*;
import com.cinaq.axxell.client.auth.*;
import com.cinaq.axxell.client.model.*;
import com.cinaq.axxell.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
DefaultApi apiInstance = new DefaultApi();
String storeid = "storeid_example"; // String | Store identifier
String eventType = "eventType_example"; // String | Valid values purchase, view or recommend
String dataPeriod = "dataPeriod_example"; // String | Valid values are last7days, last30days, today, yesterday
try {
DataPoint result = apiInstance.aggregateCountEvents(storeid, eventType, dataPeriod);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#aggregateCountEvents");
e.printStackTrace();
}
}
}
All URIs are relative to https://axxell.cinaq.com/v1/
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | aggregateCountEvents | GET /aggregates/countevents/{eventType} | |
DefaultApi | aggregateEffective | GET /aggregates/effective/{eventType} | |
DefaultApi | aggregateEvents | GET /aggregates/events/{eventType} | |
DefaultApi | aggregateRecent | GET /aggregates/recent/{eventType} | |
DefaultApi | aggregateTop | GET /aggregates/top/{eventType} | |
DefaultApi | authStore | POST /auth | |
DefaultApi | deleteAllEvents | DELETE /events | |
DefaultApi | deleteAllItems | DELETE /items | |
DefaultApi | deleteItem | DELETE /items/{itemid} | |
DefaultApi | recommendInteresting | GET /recommendations/interesting | |
DefaultApi | recommendSimilar | GET /recommendations/similar | |
DefaultApi | registerEvent | POST /events | |
DefaultApi | registerItem | POST /items | |
DefaultApi | registerStore | POST /store | |
DefaultApi | retrieveEvents | GET /events | |
DefaultApi | retrieveItems | GET /items |
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.
Auto generated, see https://github.com/cinaq/axxell-specifications