ProptechOS Rest API client

ProptechOS Rest API client to be used for calling ProptechOS API main CRUD operations.

How to start:

In order to include library as a dependency into pom.xml

• ProptechOS maven repository:

<repositories>
    <repository>
        <id>p8s-sdk</id>
        <url>https://pkgs.dev.azure.com/idun-corp/957eb9f4-fe48-42f6-901e-60ebc7add052/_packaging/p8s-sdk/maven/v1</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

• Library dependency:

<dependency>
    <groupId>com.proptechos</groupId>
    <artifactId>proptechos-rest-api-java-client</artifactId>
    <version>4.2.0-SNAPSHOT</version>
</dependency>

Start using ProptechOsClient:

To start using SDK library instance of ProptechOsClient should be initialized:

ProptechOsClient.applicationClientBuilder("<BASE_API_URL>")
    .authConfig(AuthenticationConfig.builder()
            .clientId("<APP_CLIENT_ID>")
            .clientSecret("<APP_CLIENT_SECRET>")
            .scope("PROPTECHOS_APP_SCOPE ").build()).build();

Properties definitions:

• BASE_API_URL - base ProptechOS api url "https://test.proptechos.com/api"
• APP_CLIENT_ID - your application id in ProptechOS (also the application ID registered in Azure Active Directory)
• APP_CLIENT_SECRET - your application secret in ProptechOS (also the secret generated for your Azure Active Directory application)
• PROPTECHOS_APP_SCOPE - ProptechOS API scope

Working with ProptechOS Services

ProptechOsClient provides access to ServiceFactory class. ServiceFactory instantiates all type of services to simplify process of integration with ProptechOS API.

DeviceService deviceService = client.serviceFactory().deviceService();

ProptechOS services provides main operations to work with ProptechOS axioms:

• CRUD operations:

getById(UUID id)

createDevice(IDevice device)

updateDevice(IDevice device)

deleteDevice(UUID id)

• Pagination

Paged<T> getFirstPage(long pageSize)

Paged<T> getPage(long pageNumber, long pageSize)

Paged<T> getPageFiltered(long pageNumber, long pageSize, IQueryFilter...filters)

Paged<T> getLastPage(long pageSize)

Paged<T> getNextPage(PageMetadata currentPageMetadata)

Example of obtaining paged filtered Data:

Paged<IDevice> pagedDevices 
    = deviceService.getPageFiltered(0, 100, new ClassFilter("Device"));

Example of query filter implementation:

public class ClassFilter implements IQueryFilter {

  private String recClass;

  public ClassFilter(String recClass) {
    this.recClass = recClass;
  }

  @Override
  public QueryParam queryParam() {
    return new QueryParam("class", recClass);
  }
}

Obtaining sensor observations

sensorService.getLatestObservationBySensorId(UUID.fromString("<SENSOR_ID>"));

sensorService.getObservationsBySensorIdForPeriod(
        UUID.fromString("<SENSOR_ID>"),
        Instant.now().minus(10, ChronoUnit.DAYS), Instant.now())

Sending actuation request

actuatorService.sendActuationRequest(
        UUID.fromString("<ACTUATOR_ID>"), "<PAYLOAD_VALUE>");

Set preferable Property Owner Id

PropertyOwnerCache.getInstance().setPropertyOwner("<PROPERTY_OWNER_ID>")

Access to StreamingApiService:

In order to obtain access to StreamingApiService, KafkaConfig data should be provided

StreamingApiService streamingApiService = 
    client.serviceFactory().streamingApiService(KafkaConfig.builder()
            .eventHub("<EVENTHUB_NAME>")
            .eventHubNamespace("<EVENTHUB_NAMESPACE>")
            .sharedAccessKey("<EVENTHUB_SHARED_ACCESS_KEY>")
            .build());

Properties definitions:

• EVENTHUB_NAME - Azure kafka enebled eventhub name
• EVENTHUB_NAMESPACE - Azure eventhub namespace
• EVENTHUB_SHARED_ACCESS_KEY - Azure eventhub namespace shared access key to connect to

You will get the necessary parameters from Idun.

Subscribe to sensor telemetry stream

KafkaStreams kStreams = 
    streamingApiService.subscribe(Consumer<Observation> consumer);

Close stream

kStreams.close();