Skip to content
English
Go to sera4.com
  • There are no suggestions because the search field is empty.

Understanding Our APIs and Workflows

Enhancing Integration and Automation with Our Platform

Overview

Our platform offers robust APIs that allow users to build automation and seamlessly integrate our services with third-party interfaces and integrators. By leveraging our APIs, you can enhance the functionality of your applications and streamline your operations.

API Documentation

Comprehensive documentation for our APIs can be found at this link. This resource includes detailed information on available endpoints, request formats, response structures, and examples to help you get started.

To start using the Sera4 APIs, you’ll need two authentication tokens that can be generated from the Teleporte Web interface: TwsHost and TwsApiOrgToken

These values are required to authenticate your API requests and connect to the correct Teleporte environment. If you have any trouble locating or generating them, please contact our Support team at support@sera4.com and we’ll be happy to help.

Get TwsHost and TwsApiOrgToken from Teleporte

 

Basic Workflows for API Integrations

To help you build API integrations efficiently, we have outlined two basic workflows:

Workflow 1: Basic User and Key Management

This workflow covers the basic scenario where an administrator creates a user and grants a key for the user to access a specific lock.

Teleporte API workflow 1

Workflow 2: Access Request and Approval Process

This workflow covers the scenario where a user submits an access request, the administrator approves the request, and then grants the key to the user for accessing the lock.

Teleporte API workflow 2

What is a Webhook?

A webhook is a way for an application to provide real-time information to other applications. It delivers data to a specified URL as soon as an event occurs, allowing for immediate processing and action.

Configuring a URL to Receive Webhooks

To configure a URL to be the recipient of our webhooks:

  1. Navigate to the "API Management" menu

  2. Enter Your URL and Enable all the events that you would like to trigger the webhook for.

    webhooks_UI_EN

Need Help?

If you encounter any issues or have questions about using our APIs or configuring webhooks, please don't hesitate to reach out to our CX team at cx@sera4.com.