How to get started

Please read this document to learn about the open platform, integration process (TTock App integration, TTHotel App integration),SDK,API, frequently asked questions,etc.

Please note: We don't provide test accounts or sandbox environments for integration. Please refer directly to the corresponding integration process for detailed instructions.

1.Open Platform

1.1、Register a developer account

The developer account is only used for application submissions and is not used for any other purpose. This account is different from TTLock App account and theses 2 accounts are unrelated to each other.

For questions related to the open platform, please refer to the documentation.:Open Platform Q&A

1.2、Create an application in the developer account and apply for it. If the application is approved, you will see the client_id and client_secret in the Application.

After creating an app, it will be in the "Under Review" status by default. It will be manually reviewed by the backend within business days. Developers will be notified by email upon successful review.

Developers can see the client_id and client_secret on the approved app details page. Please keep these details secure.

If you have multiple projects, a single developer account can create multiple apps.

2.TTLock App Integration

2.1、Add locks in TTlock App

Search for "TTLock" in the stores, download and install the APP, register a user account, and add locks.

TTLock Tutorial:AppWeb

2.2、Get TTlock Account‘s Access Token

Use the TTLock App account and password registered in 2.1 & the client_id and client_secret (applied in 1.2 ) to call the cloud API to obtain the access token of the added lock account. Note that the accessToken will expire after the time indicated by expires_in. After expiration, you need to obtain it again or refresh

2.3、After obtaining the accessToken, you can use it to call other APIs

Please refer to the link for detailed steps:How to integrate with TTlock App

3.TTHotel Integration

To integrate with TTHotel, you do not need to register a developer account or apply for an application on the open platform. You can directly go to the TTHotel computer client - Settings - Integration - Get the integration information. The integration information includes client_id, client_secret, username and password. You can use the integration information to call the APIs. For details, please refer to the document:How to integrate with TThote & Card encoder

TTHotel Tutorial:introduction | TTHotel help center

4.API

Provides lock, password, electronic key, IC card, fingerprint, gateway and other related interfaces. For specific interface documents, please refer to the open platform Cloud API v3 section

The open platform includes more than just the APIs described below; you can explore other APIs by referring to the Cloud API v3 section of the open platform documentation.

5.SDK

IOS:IOS SDK & Demo

Android:Android SDK & Demo

Flutter :Flutter SDK & Demo

6.On-premise(Fee required)

If you want to store all data on your own server, you can perform local deployment. Please refer to the document for details: on-premise

7.FAQs

This section summarizes common issues encountered during the integration process, including locks, open platforms, integration, passwords, gateways and Wi-Fi locks, card issuance, and callback URL.

For more information, please refer to the following link:FAQs