Compreendendo Nossas APIs e Workflows

Visão Geral

Nossa plataforma oferece APIs robustas que permitem aos usuários construir automações e integrar nossos serviços de forma contínua com interfaces e integradores de terceiros. Ao aproveitar nossas APIs, você pode aprimorar a funcionalidade de suas aplicações e simplificar suas operações.

Documentação da API

A documentação completa de nossas APIs pode ser encontrada neste link. Esta página inclui informações detalhadas sobre os endpoints disponíveis, formatos de requisição, estruturas de resposta e exemplos para ajudá-lo a começar.

Depois de obter os valores de TwsHost e TwsApiOrgToken, você pode começar a usar nossas APIs. Se você não tiver esses valores, por favor, entre em contato conosco pelo email cx@sera4.com.

Obtenha TwsHost e TwsApiOrgToken da Teleporte

Workflows Básicos para Integrações com API

Para ajudá-lo a construir integrações com API de forma eficiente, descrevemos dois workflows básicos:

Workflow 1: Gerenciamento Básico de Usuários e Chaves

Este workflow cobre o cenário mais básico no qual o administrador cria um usuário e concede uma chave para este acessar um determinado cadeado.

Workflow 2: Processo de Solicitação e Aprovação de Acesso

Este workflow cobre o cenário em que o usuário submete uma requisição de acesso, o administrador aprova a requisição e concede a chave para o usuário e cadeado.

O que é um Webhook?

Um webhook é uma maneira de uma aplicação fornecer informações em tempo real para outras aplicações. Ele entrega dados para uma URL especificada assim que um evento ocorre, permitindo processamento e ação imediatos.

Configurando uma URL para Receber Webhooks

Para configurar uma URL para ser o destinatário de nossos webhooks:

1. Navegue até o menu "Gerenciamento de API"
2. Insira sua URL e habilite todos os eventos que você gostaria que acionassem o webhook.
   

Precisa de Ajuda?

Se você encontrar algum problema ou tiver dúvidas sobre o uso de nossas APIs ou a configuração de webhooks, não hesite em entrar em contato com nossa equipe de CX pelo email cx@sera4.com.