Connect and control any Akiles device using the Seam API.
Connect and control any Akiles device using the Seam API.
| Capability | Required Accessories |
|---|---|
| Remote unlock |
|
| Access codes |
|
| Akiles Contact Page | https://akiles.app/en/contact | akiles-logo.png |
Akiles smart locks
+{% endhint %}
+
+### Create a Connect Webview
+
+Create a `connect_webview` object and then note the returned URL.
+
+{% tabs %}
+{% tab title="Python" %}
+**Code:**
+
+```python
+from seam import Seam
+
+seam = Seam() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(accepted_providers=["akiles"])
+
+assert connect_webview.login_successful is False
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+print(connect_webview.url)
+```
+
+**Output:**
+
+```
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="cURL (bash)" %}
+**Code:**
+
+```bash
+curl -X 'POST' \
+ 'https://connect.getseam.com/connect_webviews/create' \
+ -H 'accept: application/json' \
+ -H "Authorization: Bearer ${SEAM_API_KEY}" \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "accepted_providers": ["akiles"]
+}' | jq -r '"Login Successful (false): " + (.connect_webview.login_successful | tostring),
+ "URL: " + .connect_webview.url'
+ # Use the returned Connect Webview URL to display
+ # the Connect Webview authorization flow to your user.
+```
+
+**Output:**
+
+```
+Login Successful (false): false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="JavaScript" %}
+**Code:**
+
+```javascript
+import { Seam } from "seam";
+
+const seam = new Seam(); // Seam automatically uses your exported SEAM_API_KEY.
+
+const connectWebview = await seam.connectWebviews.create({
+ accepted_providers: ['akiles']
+});
+
+console.log(connectWebview.login_successful); // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+console.log(connectWebview.url);
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+**Code:**
+
+```ruby
+require "seamapi"
+
+seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(
+ accepted_providers: ["akiles"]
+)
+
+puts connect_webview.login_successful # false
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+puts connect_webview.url
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+**Code:**
+
+```php
+connect_webviews->create(
+ accepted_providers: ["akiles"]
+);
+
+echo $connect_webview->login_successful ? 'true' : 'false', "\n"; // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+echo $connect_webview->url;
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="C#" %}
+**Code:**
+
+```csharp
+using Seam.Client;
+
+var seam = new SeamClient(apiToken: SEAM_API_KEY);
+
+var connectWebview = seam.ConnectWebviews.Create(
+ acceptedProviders: new() {Seam.Api.ConnectWebviews.CreateRequest.AcceptedProvidersEnum.Akiles}
+);
+
+Console.WriteLine(connectWebview.LoginSuccessful); // False
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+Console.WriteLine(connectWebview.Url);
+```
+
+**Output:**
+
+```
+False
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Java" %}
+**Code:**
+
+```java
+import java.io.Console;
+import java.util.*;
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.seam.api.Seam;
+import com.seam.api.core.ObjectMappers;
+import com.seam.api.types.ConnectWebview;
+import com.seam.api.types.Device;
+import com.seam.api.types.Manufacturer;
+import com.seam.api.types.ActionAttempt;
+import com.seam.api.types.AccessCode;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsCreateRequest;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsGetRequest;
+import com.seam.api.resources.devices.requests.DevicesListRequest;
+import com.seam.api.resources.devices.requests.DevicesGetRequest;
+import com.seam.api.resources.locks.requests.LocksUnlockDoorRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesCreateRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesListRequest;
+
+public class Main {
+
+ public static void main(String[] args) {
+
+ Seam seam = Seam.builder()
+ .apiKey(SEAM_API_KEY)
+ .build();
+
+ ConnectWebview connectWebview = seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder()
+ .acceptedProviders(List.of(AcceptedProvider.AKILES))
+ .build());
+
+ System.out.println(connectWebview.getLoginSuccessful()); // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ System.out.println(connectWebview.getUrl());
+
+ }
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Go" %}
+**Code:**
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "os"
+
+ api "github.com/seamapi/go"
+ seam "github.com/seamapi/go/client"
+)
+
+func main() {
+ if err := run(); err != nil {
+ _, _ = fmt.Fprintln(os.Stderr, err.Error())
+ os.Exit(1)
+ }
+}
+
+func run() error {
+ client := seam.NewClient(
+ seam.WithApiKey(SEAM_API_KEY),
+ )
+
+ connectWebview, err := client.ConnectWebviews.Create(
+ context.Background(),
+ &api.ConnectWebviewsCreateRequest{
+ AcceptedProviders: []api.AcceptedProvider{
+ api.AcceptedProviderAkiles,
+ },
+ },
+ )
+
+ if err != nil {
+ return err
+ }
+
+ fmt.Println(connectWebview.LoginSuccessful) // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ fmt.Println(connectWebview.Url)
+
+ return nil
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Authorize your workspace
+
+In a web browser, go to the URL that the Connect Webview object returned.
+
+For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../seam-components/react-components/connect-account-button.md) within our suite of [Seam Components](../../seam-components/overview/) that help you build your device management flow.
+
+{% hint style="success" %}
+Because you're using a sandbox workspace, you can connect Seam's test Akiles account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices.
+{% endhint %}
+
+Complete the Connect Webview authorization flow by entering the following [Akiles sandbox account](../../developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md) credentials:
+
+* **Email:** jane@example.com
+* **Password:** 1234
+
+
Use the Seam Connect Webview authorization flow to connect an Akiles account with Seam. This flow varies slightly based on the device manufacturer.
// Get the device by ID.
+const updatedFrontDoor = await seam.devices.get({device_id: frontDoor.device_id});
+
+// Inspect the locked property to confirm
+// that the unlock operation was successful.
+console.log(updatedFrontDoor.properties.locked) // false
+
Seam Components make it easy to develop your application!
| Get an API Key (free) | Sign up for the Seam Console and get your API keys. → | seam-api-key.png | https://console.seam.co/ | |
| Contact Sales | Got a project or a specific question? Contact our team to get answers. → | seam-contact-us-light.png | https://www.seam.co/contact-us |
| 2N Intercom Systems | 2n-logo.png | 2n-intercom-systems.md | ||
| 4SUITES Locks | 4suites-logo.png | 4suites-locks | ||
| August Locks | august-logo.png | august-locks.md | ||
| dormakaba Oracode Locks | dormakaba-logo.png | dormakaba-oracode-locks.md | ||
| iglooHome Locks | igloohome-logo.png | igloohome-locks.md | ||
| Kwikset Locks | kwikset-logo.png | kwikset-locks.md | ||
| Lockly Locks | lockly-logo.png | lockly-locks | ||
| Nuki Locks | nuki-logo.png | nuki-locks.md | ||
| Salto Locks | salto-logo.png | salto-locks.md | ||
| Schlage Locks | schlage-logo.png | get-started-with-schlage-locks.md | ||
| SmartThings Hubs + Smart Locks | smartthings-logo.png | get-started-with-smartthings-hubs-+-smart-locks.md | ||
| Tedee Locks | tedee-logo.png | tedee-locks | ||
| TTLock Locks | ttlock-logo.png | ttlock-locks.md | ||
| Wyze Locks | wyze-logo.png | wyze-locks.md | ||
| Yale Locks | yale-logo.png | yale-locks.md |
| 2N Intercom Systems | 2n-logo.png | 2n-intercom-systems.md | ||
| 4SUITES Locks | 4suites-logo.png | 4suites-locks | ||
| Akiles Locks | akiles-logo.png | akiles-locks | ||
| August Locks | august-logo.png | august-locks.md | ||
| dormakaba Oracode Locks | dormakaba-logo.png | dormakaba-oracode-locks.md | ||
| iglooHome Locks | igloohome-logo.png | igloohome-locks.md | ||
| Kwikset Locks | kwikset-logo.png | kwikset-locks.md | ||
| Lockly Locks | lockly-logo.png | lockly-locks | ||
| Nuki Locks | nuki-logo.png | nuki-locks.md | ||
| Salto Locks | salto-logo.png | salto-locks.md | ||
| Schlage Locks | schlage-logo.png | get-started-with-schlage-locks.md | ||
| SmartThings Hubs + Smart Locks | smartthings-logo.png | get-started-with-smartthings-hubs-+-smart-locks.md | ||
| Tedee Locks | tedee-logo.png | tedee-locks | ||
| TTLock Locks | ttlock-logo.png | ttlock-locks.md | ||
| Wyze Locks | wyze-logo.png | wyze-locks.md | ||
| Yale Locks | yale-logo.png | yale-locks.md |
