igloohome API

https://igloocompany.stoplight.io/docs/igloohome-api/
Admin
igloohome API is a smart access control platform that provides PIN generation, Bluetooth key...
Tokens:22,756
Snippets:253
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Authentication Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/c0431bbef586d-getting-started-with-iglooconnect

A curl example demonstrating the initial authentication request with parameters.

```bash
curl "https://auth.igloohome.co/login?client_id=your_client_id&response_type=code&redirect_uri=https%3A%2F%2Fyourapp.com%2Fcallback&scope=igloohomeapi%2Fget-devices+openid+profile&state=xyz987"
```

--------------------------------

### iOS Install Command

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Run the pod install command to install the IglooAccessSDK dependencies.

```bash
pod install
```

--------------------------------

### Example Token Exchange Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/c0431bbef586d-getting-started-with-iglooconnect

A curl example for exchanging an authorization code for tokens.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Authorization: Basic NThucjFwcjgyMTlj...' \
  --data grant_type=authorization_code \
  --data client_id=58nr1... \
  --data code=86b48b3d-****-****-****-********** \
  --data redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fcallback
```

--------------------------------

### cURL Request Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/1w1cuv56ge5xq-overview

Example cURL command demonstrating the required Authorization and Content-Type headers.

```bash
curl -X POST -H "Authorization: Bearer {access_token}" -H "Content-Type: application/json"
```

--------------------------------

### Sync with Status Example (Kotlin)

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example usage of the syncWithStatus method in Kotlin, demonstrating how to handle completion, errors, and individual sub-process status updates.

```kotlin
try {
    iglooPlugin.syncWithStatus(
        "BLUETOOTH_DEVICE_NAME",
        "BLUETOOTH_KEY",
        timeInSeconds = <EPOCH IN SECONDS>,
        getDeviceToken = "GET_DEVICE_TOKEN",
        storeLogsToken = "STORE_LOGS_TOKEN",
        updateDeviceToken = "UPDATE_DEVICE_TOKEN",
    )
        .onCompletion {
            // Do something when process completed
        }
        .catch { error ->
            // Do something when error
        }
        .collect { status ->
            if (status.isSuccess) {
                // Do something when the sub process success
            } else {
                // Do something when the sub process error
            }
        }
} catch (e: Throwable) {
    // Handle error
}
```

--------------------------------

### One-Time PIN Usage Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Example request for creating a One-Time PIN with 24-hour validity.

```json
One-Time PIN (24-hour validity):
{
  "jobType": 4,
  "jobData": {
    "accessName": "OTP PIN",
    "pin": "123456",
    "pinType": 1,
    "startDate": "2024-01-01T00:00:00+00:00"
  }
}
```

--------------------------------

### Initiate IglooPlugin on iOS

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of initializing the IglooPlugin within an iOS ViewModel.

```swift
import IglooPluginSDK


class MyViewModel: ObservableObject {
    let iglooPlugin = IglooPlugin()
}
```

--------------------------------

### Token Refresh cURL Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/c0431bbef586d-getting-started-with-iglooconnect

A practical example of using cURL to perform the token refresh request.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Authorization: Basic NThucjFwcjgyMTlj...' \
  --data grant_type=refresh_token \
  --data client_id=58nr1... \
  --data refresh_token=dn43ud8uj32nk2je
```

--------------------------------

### cURL Request Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/8uellqkosv7ry-create-a-bridge-targeted-job

Example of how to send the POST request using cURL, including headers and the jobType data.

```bash
curl --request POST \
  --url https://api.igloodeveloper.co/igloohome/devices/{deviceId}/jobs \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --data '{
  "jobType": 10
}'
```

--------------------------------

### Initiate IglooPlugin on Android

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of initializing the IglooPlugin within an Android Application class.

```kotlin
class MyApplication : Application() {
    /**
     * Instance of the IglooPlugin.
     */
    private lateinit var iglooPlugin: IglooPlugin
    
    override fun onCreate() {
        super.onCreate()
        // Initializes the `iglooPlugin` with the application context.
        iglooPlugin = IglooPlugin(this.applicationContext)
    }
}
```

--------------------------------

### Sync Device Example for iOS

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Demonstrates how to perform a device sync on iOS using Swift's async/await pattern.

```swift
do {
    let syncResult = try await iglooPlugin.sync(
        "BLUEOOTH_DEVICE_NAME", 
        "KEY",
        getDeviceToken: "GET DEVICE ACCESS TOKEN",
        storeLogsToken: "STORE LOGS ACCESS TOKEN")
} catch {
    // Handle Error
}
```

--------------------------------

### Lock Device on iOS

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of using the lock command on iOS using async/await.

```swift
do {
    try await iglooPlugin.lock("BLUETOOTH_DEVICE_NAME", "KEY")
} catch {
    // Handler Error
}
```

--------------------------------

### Request Body Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ae3e61e390eab-create-a-bridge-proxied-job

Example JSON payload for creating a bridge-proxied job, such as creating a custom PIN code.

```json
{
  "jobType": 4,
  "jobData": {
    "accessName": "Maintenance guy",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2022-10-10T12:00:00+08:00",
    "endDate": "2022-10-10T16:00:00+08:00"
  }
}
```

--------------------------------

### Unlock Device on iOS

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of using the unlock command on iOS using async/await.

```swift
do {
    try await iglooPlugin.unlock("BLUETOOTH_DEVICE_NAME", "KEY")
} catch {
    // Handle Error
}
```

--------------------------------

### Sync Device Example for Android

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Demonstrates how to perform a device sync on Android within a lifecycle scope, including a permission check.

```kotlin
lifecycleScope.launch {
    try {
         if (!isPermissionGranted()) {
            requestPermission()
            return@launch
        }


        val syncResult = iglooPlugin.sync(
            "BLUETOOTH_DEVICE_NAME", 
            "KEY",
            getDeviceToken = "GET DEVICE ACCESS TOKEN",
            storeLogsToken = "STORE LOGS ACCESS TOKEN",
            updateDeviceToken = "UPDATE DEVICE ACCESS TOKEN",
        )
    } catch(e: Throwable) {
        // Handle Error
    }
}
```

--------------------------------

### Get Job Status Response Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/74fd6741cfc20-get-job-status

A successful 200 OK response returns the job details, including the jobId, expiryDate, completion status, and the nested jobResponse object.

```json
{
  "jobId": "6345191a82bcfc12a921bdb6",
  "expiryDate": "2025-01-01T00:02:00.000Z",
  "completed": true,
  "jobType": "UNLOCK",
  "jobResponse": {
    "jobStatus": 0,
    "opResult": {
      "result": 0
    }
  }
}
```

--------------------------------

### Example HTTPS Webhook Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/cd0c12b955d30-webhook-security

An example of an incoming POST request containing the 'x-igloocompany-sha256' signature header.

```http
POST /example/path HTTP/1.1
Host: example-host.com
Date: Sat, 20 Jun 2015 12:34:56 GMT
Accept: application/json
Content-Type: application/json
Content-Length: 29
x-igloocompany-sha256: "QA...=="


{ "payload": "example payload" }
```

--------------------------------

### cURL Request Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ae3e61e390eab-create-a-bridge-proxied-job

A sample cURL command to execute the POST request to the bridge-proxied job endpoint.

```bash
curl --request POST \
  --url https://api.igloodeveloper.co/igloohome/devices/{deviceId}/jobs/bridges/{bridgeId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --data '{
  "jobType": 4,
  "jobData": {
    "accessName": "Maintenance guy",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2022-10-10T12:00:00+08:00",
    "endDate": "2022-10-10T16:00:00+08:00"
  }
}'
```

--------------------------------

### Request Body Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/8uellqkosv7ry-create-a-bridge-targeted-job

The JSON body required to create a job, specifying the jobType.

```json
{
  "jobType": 10
}
```

--------------------------------

### Response Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/8uellqkosv7ry-create-a-bridge-targeted-job

The expected JSON response containing the jobId upon a successful request.

```json
{
  "jobId": "string"
}
```

--------------------------------

### Lock Device on Android

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of using the lock command on Android, including a prerequisite permission check.

```kotlin
lifecycleScope.launch {
    try {
         if (!isPermissionGranted()) {
            requestPermission()
            return@launch
        }


        iglooPlugin.lock("BLUETOOTH_DEVICE_NAME", "KEY")
    } catch(e: Throwable) {
        // Handle Error
    }
}
```

--------------------------------

### Unlock Device on Android

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example of using the unlock command on Android, including a prerequisite permission check.

```kotlin
lifecycleScope.launch {
    try {
        if (!isPermissionGranted()) {
            requestPermission()
            return@launch
        }


        val res = iglooPlugin.unlock("BLUETOOTH_DEVICE_NAME", "KEY")
    } catch(e: Throwable) {
        // Handle Error
    }
}
```

--------------------------------

### Using Access Token in API Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Example of how to include the Bearer token in the Authorization header for API requests.

```bash
curl --request GET \
  --url https://api.igloodeveloper.co/igloohome/devices \
  --header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### GET /login

Source: https://igloocompany.stoplight.io/docs/igloohome-api/c0431bbef586d-getting-started-with-iglooconnect

Redirects the user to the igloohome login page to initiate the OAuth2 authorization flow.

```APIDOC
## GET https://auth.igloohome.co/login

### Description
Redirects users to the igloohome login page to obtain an authorization code.

### Method
GET

### Endpoint
https://auth.igloohome.co/login

### Parameters
#### Query Parameters
- **response_type** (string) - Required - Must be 'code'
- **client_id** (string) - Required - Your client ID from igloohome
- **redirect_uri** (string) - Required - Your callback URL (URL encoded)
- **scope** (string) - Required - Space-separated scope list
- **state** (string) - Optional - Used for security and state preservation
```

--------------------------------

### Request Bluetooth Permissions on Android

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Example function to request necessary Bluetooth permissions based on the Android SDK version.

```kotlin
private fun requestPermission() {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
        ActivityCompat.requestPermissions(
            this@MainActivity, arrayOf(
                Manifest.permission.BLUETOOTH_SCAN, Manifest.permission.BLUETOOTH_CONNECT
            ), 100
        )
    } else {
        ActivityCompat.requestPermissions(
            this@MainActivity, arrayOf(
                Manifest.permission.ACCESS_FINE_LOCATION
            ), 100
        )
    }
}
```

--------------------------------

### GET https://api.igloodeveloper.co/igloohome/jobs/{jobId}

Source: https://igloocompany.stoplight.io/docs/igloohome-api/74fd6741cfc20-get-job-status

Retrieves the status and details of a job by its ID.

```APIDOC
## GET https://api.igloodeveloper.co/igloohome/jobs/{jobId}

### Description
Retrieves the status and details of a job by its ID.

### Method
GET

### Endpoint
https://api.igloodeveloper.co/igloohome/jobs/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The unique identifier of the job.

### Response
#### Success Response (200)
- **jobId** (string) - The ID of the job.
- **expiryDate** (string) - The expiration date of the job.
- **completed** (boolean) - Indicates if the job is completed.
- **jobType** (string) - The type of job performed.
- **jobResponse** (object) - Contains the job status and operation result.

#### Response Example
{
  "jobId": "6345191a82bcfc12a921bdb6",
  "expiryDate": "2025-01-01T00:02:00.000Z",
  "completed": true,
  "jobType": "UNLOCK",
  "jobResponse": {
    "jobStatus": 0,
    "opResult": {
      "result": 0
    }
  }
}
```

--------------------------------

### GET /igloohome/devices

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Retrieves a list of devices using the Bearer token authentication method.

```APIDOC
## GET /igloohome/devices

### Description
Retrieves a list of devices associated with the account. Requires a valid Bearer token in the Authorization header.

### Method
GET

### Endpoint
https://api.igloodeveloper.co/igloohome/devices

### Request Example
curl --request GET \
  --url https://api.igloodeveloper.co/igloohome/devices \
  --header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### Get Activity Logs

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Downloads activity logs from the lock. Optionally synchronizes the lock's clock.

```APIDOC
## Get Activity Logs

### Description
Downloads activity logs from the lock. Optionally synchronizes the lock's clock.

### Parameters
- **lockTime** (ISO_DATE) - Optional - Synchronize the lock's clock

### Request Example
{
  "jobType": 15,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}
```

--------------------------------

### Get Activity Logs Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Request to download activity logs from the lock. Note that logs are deleted from the device after retrieval.

```json
{
  "jobType": 15,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}
```

--------------------------------

### Node.js Signature Validation Example

Source: https://igloocompany.stoplight.io/docs/igloohome-api/cd0c12b955d30-webhook-security

A Node.js implementation using the crypto library to validate a webhook signature against a base64-encoded public key.

```javascript
// Using nodejs crypto library.
import * as crypto from 'crypto';


// The example payload that we'll be validating.
const payload = 'POST|example-host.com|/example/path|application/json|Sat, 20 Jun 2015 12:34:56 GMT|{"payload":"example payload"}';


// We use SHA-256 hash algorithm in both the HMAC computation and signature validation.
const hashAlgorithm = 'sha256';


// Decode both the public key string and signature string.
// (Assuming `publicKeyString` and `signatureString` are both valid.)
const publicKey = Buffer.from(publicKeyString, 'base64');
const signature = Buffer.from(signatureString, 'base64');


// Compute the hash using HMAC.
const hmacDigest = crypto.createHmac(hashAlgorithm, publicKey)
  .update(payload, 'ascii')
  .digest();


// Validate signature.
const result = crypto.verify(
  hashAlgorithm,
  hmacDigest,
  crypto.createPublicKey({
      key: publicKey,
      format: 'der',
      type: 'pkcs1'
  }),
  signature
);


// Output validation result.
console.log('signature valid:', result); // signature valid: true
```

--------------------------------

### Get Battery Level Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Request to retrieve the current battery level of the lock as a percentage.

```json
{
  "jobType": 9
}
```

--------------------------------

### Get Device Status Webhook

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ax5zas6u26yn9-job-specific-webhook-data

Describes the webhook payload structure for retrieving the current status of the device, including lock and door states.

```APIDOC
## Get Device Status

### Description
This webhook payload provides the current status of the device, indicating whether the lock and door are open or closed.

### Request Example
{
  "event": {
    "id": "string",
    "type": 3,
    "data": {
      "jobId": "string",
      "jobStatus": 0,
      "lockOpen": false,
      "doorOpen": true
    },
    "date": "ISO_DATE",
    "proxyTransportMethod": 2,
    "accessoryId": "string"
  },
  "product": {
    "id": "string",
    "type": 1
  }
}
```

--------------------------------

### Get Device Status Job Payload

Source: https://igloocompany.stoplight.io/docs/igloohome-api/b0amiokly9501-bridge-targeted-jobs

The specific payload format for the Get Device Status (Bridge Diagnostic) job type.

```json
{
    jobType: 10
}
```

--------------------------------

### Get Job Status cURL Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/74fd6741cfc20-get-job-status

Use this cURL command to perform a GET request to the job status endpoint. Ensure you include a valid Bearer token in the Authorization header.

```shell
curl --request GET \
  --url https://api.igloodeveloper.co/igloohome/jobs/{jobId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'
```

--------------------------------

### Get Device Status

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Queries the lock's current operational status.

```APIDOC
## Get Device Status

### Description
Queries the lock's current operational status.

### Request Example
{
  "jobType": 10
}
```

--------------------------------

### iOS Podfile Configuration

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Add the IglooAccessSDK to your Podfile and configure the post_install settings.

```ruby
pod 'IglooAccessSDK', :git => 'https://<GITLAB_USERNAME>:<ACCESS_TOKEN>@gitlab.com/igloohome/iglooaccess-ios-sdk.git', :tag => '<latest-sdk-version>'
```

```ruby
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = "arm64"
config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
```

--------------------------------

### Clone igloohome SDK Repositories

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Commands to clone the Android and iOS SDK repositories using a GitLab private token.

```bash
git clone https://gitlab:<your_gitlab_private_token>@gitlab.com/igloohome/iglooaccess-android-sdk.git
git clone https://gitlab:<your_gitlab_private_token>@gitlab.com/igloohome/iglooaccess-ios-sdk.git
```

--------------------------------

### Get Battery Level

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Retrieves the lock's current battery level as a percentage.

```APIDOC
## Get Battery Level

### Description
Retrieves the lock's current battery level as a percentage.

### Request Example
{
  "jobType": 9
}
```

--------------------------------

### Initiate Authentication Redirect

Source: https://igloocompany.stoplight.io/docs/igloohome-api/c0431bbef586d-getting-started-with-iglooconnect

Redirect users to the igloohome login page with the required parameters.

```http
https://auth.igloohome.co/login?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPES}&state={STATE}
```

--------------------------------

### POST /igloohome/devices/{deviceId}/jobs/bridges/{bridgeId}

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ae3e61e390eab-create-a-bridge-proxied-job

Creates a job for a lock via a Bridge device.

```APIDOC
## POST /igloohome/devices/{deviceId}/jobs/bridges/{bridgeId}

### Description
Creates a job for a lock via a Bridge device.

### Method
POST

### Endpoint
https://api.igloodeveloper.co/igloohome/devices/{deviceId}/jobs/bridges/{bridgeId}

### Parameters
#### Path Parameters
- **bridgeId** (string) - Required - Bluetooth ID of the Bridge
- **deviceId** (string) - Required - Bluetooth ID of the Bridge-connected device

#### Request Body
- **jobType** (integer) - Required - The type of job to perform
- **jobData** (object) - Optional - Data associated with the job
  - **accessName** (string) - Optional
  - **pinType** (integer) - Required
  - **pin** (string) - Required
  - **startDate** (string) - Required
  - **endDate** (string) - Required

### Request Example
{
  "jobType": 4,
  "jobData": {
    "accessName": "Maintenance guy",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2022-10-10T12:00:00+08:00",
    "endDate": "2022-10-10T16:00:00+08:00"
  }
}

### Response
#### Success Response (200)
- **jobId** (string) - The ID of the created job

#### Response Example
{
  "jobId": "6345191a82bcfc12a921bdb6"
}
```

--------------------------------

### POST /igloohome/devices/{deviceId}/jobs

Source: https://igloocompany.stoplight.io/docs/igloohome-api/8uellqkosv7ry-create-a-bridge-targeted-job

Creates a job for a Bridge device.

```APIDOC
## POST /igloohome/devices/{deviceId}/jobs

### Description
Creates a job for a Bridge.

### Method
POST

### Endpoint
https://api.igloodeveloper.co/igloohome/devices/{deviceId}/jobs

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

#### Request Body
- **jobType** (integer<int32>) - Required - The type of job to be created.

### Request Example
{
  "jobType": 10
}

### Response
#### Success Response (200)
- **jobId** (string) - The unique identifier of the created job.

#### Response Example
{
  "jobId": "string"
}
```

--------------------------------

### Base64 Encode Credentials in JavaScript

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Demonstrates how to concatenate and Base64 encode your Client ID and Client Secret for use in the Authorization header.

```javascript
const clientId = "your_client_id_here";
const clientSecret = "your_client_secret_here";
const credentials = btoa(`${clientId}:${clientSecret}`);
// Result: "eW91cl9jbGllbnRfaWRfaGVyZTp5b3VyX2NsaWVudF9zZWNyZXRfaGVyZQ=="
```

--------------------------------

### Android Kotlin DSL Repository Configuration

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Register the IglooPlugin repository and credentials in settings.gradle.kts using Kotlin DSL.

```kotlin
repositories {
  google()
  mavenCentral()
  maven {
      url = uri("https://gitlab.com/api/v4/projects/64441730/packages/maven")
      name = "GitLab"
      authentication {
          create<BasicAuthentication>("basic")
      }
      credentials {
          username = "Private-Token"
          password = "Generated Personal Access Token"
      }
  }
}
```

--------------------------------

### Request Device Management Access Token

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Requests an access token for applications requiring full device control and monitoring capabilities.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Authorization: Basic {credentials}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data 'scope=igloohomeapi/get-devices igloohomeapi/lock-bridge-proxied-job igloohomeapi/unlock-bridge-proxied-job igloohomeapi/get-device-status-bridge-proxied-job'
```

--------------------------------

### Get Battery Level Webhook

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ax5zas6u26yn9-job-specific-webhook-data

Describes the webhook payload structure for retrieving the current battery level of a device.

```APIDOC
## Get Battery Level

### Description
This webhook payload provides the current battery level of the device as a percentage, along with the job status.

### Request Example
{
  "event": {
    "id": "string",
    "type": 3,
    "data": {
      "jobId": "string",
      "jobStatus": 0,
      "batteryLevel": 75
    },
    "date": "ISO_DATE",
    "proxyTransportMethod": 2,
    "accessoryId": "string"
  },
  "product": {
    "id": "string",
    "type": 1
  }
}
```

--------------------------------

### Request Sample: Shell / cURL

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ll14dkkm8dhkw-your-get-endpoint

A cURL command to perform a POST request to the device endpoint with the required Authorization header.

```shell
curl --request POST \
  --url https://api.igloodeveloper.co/igloohome/devices/{bluetoothId} \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json'
```

--------------------------------

### Android Manifest Permissions

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Include necessary network and Bluetooth permissions in your AndroidManifest.xml file.

```xml
<!-- Required for network communication, such as accessing web services. -->
<uses-permission android:name="android.permission.INTERNET" />


<!-- Required for establishing Bluetooth connections with other devices. -->
<!-- This permission is introduced in Android 12 (API level 31). -->
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />


<!-- Required for scanning for Bluetooth devices. -->
<!-- This permission is introduced in Android 12 (API level 31). -->
<!-- Use android:usesPermissionFlags="neverForLocation" if location is not needed -->
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />


<!-- Required for scanning for Bluetooth devices for Android below 11 below. -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
```

--------------------------------

### Request Access Token with All Permissions

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

A cURL command to request an access token with all available permissions using the client credentials grant type.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Authorization: Basic {your_encoded_credentials}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials
```

--------------------------------

### POST /devices/{deviceId}/jobs/bridges/{bridgeId}

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Creates a new job to be executed by a Bridge device for a specific smart lock.

```APIDOC
## POST /devices/{deviceId}/jobs/bridges/{bridgeId}

### Description
Creates a job by sending a command to a smart lock through a Bridge device.

### Method
POST

### Endpoint
/devices/{deviceId}/jobs/bridges/{bridgeId}

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The ID of the smart lock device.
- **bridgeId** (string) - Required - The ID of the Bridge device.

#### Request Body
- **jobType** (number) - Required - Command type identifier.
- **jobData** (object) - Required - Command-specific parameters.

### Response
#### Success Response (200)
- **jobId** (string) - The unique identifier for the created job.
```

--------------------------------

### syncWithStatus

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Synchronizes the device associated with the given Bluetooth device name, providing a detailed status report for each internal process.

```APIDOC
## syncWithStatus

### Description
Synchronizes the device associated with the given Bluetooth device name. This method performs setTime, batteryLevel pull, and activityLog retrieval, ensuring all sub-processes are attempted regardless of individual failures.

### Parameters
- **bluetoothDeviceName** (string) - Required - The name of the Bluetooth device to lock.
- **key** (string) - Required - The bluetooth key for this bluetooth device.
- **getDevicesToken** (string) - Required - Access token for getting device information (Scope: igloohomeapi/get-devices).
- **storeLogsToken** (string) - Required - Access token for storing lock activity logs (Scope: igloohomeapi/store-device-activity).
- **updateDeviceToken** (string) - Required - Access token for updating device information (Scope: igloohomeapi/update-device).
- **timeInSeconds** (integer) - Optional - Time in seconds to set the lock time.
- **operationId** (string) - Optional - Operation ID for tracking the request.

### Throws
- **IglooAccessException.BluetoothException(708)**: Bluetooth service disabled.
- **IglooAccessException.GenericException**: Unhandled Error.

### Example
```kotlin
try {
    iglooPlugin.syncWithStatus(
        "BLUETOOTH_DEVICE_NAME",
        "BLUETOOTH_KEY",
        timeInSeconds = <EPOCH IN SECONDS>,
        getDeviceToken = "GET_DEVICE_TOKEN",
        storeLogsToken = "STORE_LOGS_TOKEN",
        updateDeviceToken = "UPDATE_DEVICE_TOKEN",
    )
        .onCompletion { /* Do something when process completed */ }
        .catch { error -> /* Do something when error */ }
        .collect { status ->
            if (status.isSuccess) { /* Do something when the sub process success */ }
            else { /* Do something when the sub process error */ }
        }
} catch (e: Throwable) { /* Handle error */ }
```
```

--------------------------------

### Get Device Status Webhook Payload

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ax5zas6u26yn9-job-specific-webhook-data

The expected JSON payload for a device status retrieval job, including lock and door open states.

```json
{
  "event": {
    "id": "string",
    "type": 3,
    "data": {
      "jobId": "string",
      "jobStatus": 0,
      "lockOpen": false,
      "doorOpen": true
    },
    "date": "ISO_DATE",
    "proxyTransportMethod": 2,
    "accessoryId": "string"
  },
  "product": {
    "id": "string",
    "type": 1
  }
}
```

--------------------------------

### Get Battery Level Webhook Payload

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ax5zas6u26yn9-job-specific-webhook-data

The expected JSON payload for a battery level retrieval job, containing the job status and battery level percentage.

```json
{
  "event": {
    "id": "string",
    "type": 3,
    "data": {
      "jobId": "string",
      "jobStatus": 0,
      "batteryLevel": 75
    },
    "date": "ISO_DATE",
    "proxyTransportMethod": 2,
    "accessoryId": "string"
  },
  "product": {
    "id": "string",
    "type": 1
  }
}
```

--------------------------------

### Authentication and Request Format

Source: https://igloocompany.stoplight.io/docs/igloohome-api/1w1cuv56ge5xq-overview

Details on how to authenticate requests and format headers for the igloohome API.

```APIDOC
## Authentication

### Description
All API requests must be authenticated using a Bearer token in the Authorization header.

### Headers
- **Authorization** (string) - Required - Bearer {access_token}
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json

### Example Request
```
curl -X POST -H "Authorization: Bearer {access_token}" -H "Content-Type: application/json"
```
```

--------------------------------

### Android Groovy DSL Repository Configuration

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Register the IglooPlugin repository and credentials in settings.gradle using Groovy DSL.

```groovy
repositories {
    google()
    mavenCentral()
    maven {
        url "https://gitlab.com/api/v4/projects/64441730/packages/maven"
        name "GitLab"
        credentials(PasswordCredentials) {
            username = "Private-Token"
            password = "Generated Personal Access Token"
        }
    }
}
```

--------------------------------

### POST /devices/{deviceId}/jobs

Source: https://igloocompany.stoplight.io/docs/igloohome-api/b0amiokly9501-bridge-targeted-jobs

Creates a new job for a specific Bridge device.

```APIDOC
## POST /devices/{deviceId}/jobs

### Description
Creates a new job targeted at a specific Bridge device.

### Method
POST

### Endpoint
/devices/{deviceId}/jobs

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the Bridge device.

#### Request Body
- **jobType** (integer) - Required - The type of job to perform (e.g., 10 for Get Device Status).

### Request Example
{
    "jobType": 10
}

### Response
#### Success Response (200)
- **jobId** (string) - The unique identifier for the created job.

#### Response Example
{
  "jobId": "string"
}
```

--------------------------------

### Request Property Management System Access Token

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Requests an access token for comprehensive property management, including all PIN types and device control functions.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Authorization: Basic {credentials}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data 'scope=igloohomeapi/algopin-permanent igloohomeapi/algopin-onetime igloohomeapi/algopin-daily igloohomeapi/get-devices igloohomeapi/lock-bridge-proxied-job igloohomeapi/unlock-bridge-proxied-job'
```

--------------------------------

### iglooPlugin.sync

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Synchronizes the device associated with the given Bluetooth device name, performing time updates, battery level retrieval, and activity log synchronization.

```APIDOC
## Method: iglooPlugin.sync

### Description
Synchronizes the device associated with the given Bluetooth device name. This operation updates the lock time, retrieves the battery level, and uploads activity logs to the server.

### Parameters
- **bluetoothDeviceName** (String) - Required - The name of the Bluetooth device to lock.
- **key** (String) - Required - The bluetooth key for this device.
- **getDevicesToken** (String) - Required - Access token with `igloohomeapi/get-devices` scope.
- **storeLogsToken** (String) - Required - Access token with `igloohomeapi/store-device-activity` scope.
- **updateDeviceToken** (String) - Required - Access token with `igloohomeapi/update-device` scope.
- **timeInSeconds** (Integer) - Optional - Time in seconds to set the lock time.
- **operationId** (String) - Optional - Tracking ID for the request.

### Throws
- **IglooAccessException.BluetoothException(703)**: Bluetooth Operation Timeout
- **IglooAccessException.BluetoothException(708)**: Bluetooth service disabled
- **IglooAccessException.ApiException(401)**: User unauthenticated
- **IglooAccessException.ApiException(403)**: Forbidden, check token validity and scopes
- **IglooAccessException.ApiException(serverStatusCode)**: Error during requesting API
- **IglooAccessException.GenericException**: Unhandled Error
```

--------------------------------

### Create Custom PIN Code Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Request to create a PIN code with specific access permissions and time restrictions.

```json
{
  "jobType": 4,
  "jobData": {
    "accessName": "Guest PIN",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2024-01-01T12:00:00+00:00",
    "endDate": "2024-01-01T16:00:00+00:00"
  }
}
```

--------------------------------

### Create Custom PIN code

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Creates a PIN code with specific access permissions and time restrictions.

```APIDOC
## Create Custom PIN code

### Description
Creates a PIN code with specific access permissions and time restrictions.

### Parameters
- **accessName** (string) - Required - Display name for the PIN code
- **pin** (string) - Required - 4-6 digit PIN code
- **pinType** (number) - Required - PIN type (1: One-Time, 2: Permanent, 4: Duration)
- **startDate** (string) - Required - When PIN becomes active (ISO_DATE format)
- **endDate** (string) - Optional - When PIN expires (ISO_DATE format)

### Request Example
{
  "jobType": 4,
  "jobData": {
    "accessName": "Guest PIN",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2024-01-01T12:00:00+00:00",
    "endDate": "2024-01-01T16:00:00+00:00"
  }
}
```

--------------------------------

### Request Access Token with Specific Permissions

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

A cURL command to request an access token with a restricted scope of permissions.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Authorization: Basic {your_encoded_credentials}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data 'scope=igloohomeapi/algopin-onetime igloohomeapi/get-devices'
```

--------------------------------

### Request One-Time PIN Access Token

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

Requests an access token limited to one-time PIN creation. Attempting to create permanent pins with this scope will result in a 403 Forbidden error.

```bash
curl --request POST \
  --url https://auth.igloohome.co/oauth2/token \
  --header 'Authorization: Basic {credentials}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data 'scope=igloohomeapi/algopin-onetime'
```

--------------------------------

### Create Custom PIN Webhook

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ax5zas6u26yn9-job-specific-webhook-data

Payload structure for the create custom PIN job webhook, including specific status codes.

```APIDOC
## Create Custom PIN Webhook

### Description
This webhook payload provides feedback on the custom PIN creation attempt.

### Expected Payload
{
  "event": {
    "id": "string",
    "type": 3,
    "data": {
      "jobId": "string",
      "jobStatus": 0
    },
    "date": "ISO_DATE",
    "proxyTransportMethod": 2,
    "accessoryId": "string"
  },
  "product": {
    "id": "string",
    "type": 1
  }
}

### Status Codes
- 5: Invalid Custom PIN length
- 9: Duplicate PIN
- 12: Insufficient PIN Storage
```

--------------------------------

### POST /igloohome/devices/{deviceId}/algopin/onetime

Source: https://igloocompany.stoplight.io/docs/igloohome-api/cbc75e9e68e0e-what-is-algo-pin

Generates a one-time algoPIN code for a specific device. The variance parameter allows for generating multiple unique codes for the same duration.

```APIDOC
## POST /igloohome/devices/{deviceId}/algopin/onetime

### Description
Generates a one-time algoPIN code for the specified device. This allows access even when the device is offline.

### Method
POST

### Endpoint
https://api.igloodeveloper.co/igloohome/devices/{deviceId}/algopin/onetime

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the igloohome device.

#### Request Body
- **variance** (integer) - Required - Used to generate multiple unique codes for the same duration.
- **startDate** (string) - Required - The start date and time for the PIN validity in ISO 8601 format.
- **accessName** (string) - Optional - A label for the access entry.

### Request Example
{
  "variance": 1,
  "startDate": "2022-01-01T00:00:00+08:00",
  "accessName": "Maintenance guy"
}
```

--------------------------------

### Android Kotlin DSL Dependency

Source: https://igloocompany.stoplight.io/docs/igloohome-api/97395de6841dd-sdk-documentation

Add the IglooAccess SDK dependency to your app's build.gradle.kts file.

```kotlin
implementation("co.igloo.access:sdk:<latest-sdk-version>")
```

--------------------------------

### Successful Authentication Response

Source: https://igloocompany.stoplight.io/docs/igloohome-api/67fb491f16f99-getting-started

The JSON response received upon successful authentication, containing the access token and its metadata.

```json
{
  "access_token": "eyJraWQiOiJKc.....",
  "expires_in": 86400,
  "token_type": "Bearer"
}
```

--------------------------------

### Lock Device Request

Source: https://igloocompany.stoplight.io/docs/igloohome-api/ck0pcqffefdc5-bridge-proxied-jobs

Request to lock the device, with an optional lockTime parameter to synchronize the internal clock.

```json
{
  "jobType": 1,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}
```
Tokens:
Raw