Aprenda a usar a nova documentação da API de Sirena

Apresentamos a nova documentação para o desenvolvimento de aplicativos de integração para a Sirena. Saiba onde se encontra e o que pode lhe proporcionar.

Agora você poderá adicionar seus aplicativos personalizados à API Sirena. Conheça a nova documentação e qual é o conteúdo de valor que ela pode oferecer a você.

documentacion Sirena

Há pouco tempo anunciamos o lançamento do nosso novo App Marketplace, onde lhe contamos que você seria capaz de encontrar integrações para os diferentes programas e aplicativos que usa diariamente em seu trabalho.

Mas lhe dissemos também que você seria capaz de fazer suas próprias integrações ou até mesmo poder desenvolver aplicativos de desenvolvedores de outras empresas.

Para fazer isso, é importante que você leia sobre a documentação que lançamos.

Por que lançamos a nova documentação da API de Sirena?

Para facilitar e concretizar o desenvolvimento desses aplicativos, a documentação oferece ferramentas, instruções e todas as informações complementares para o desenvolvimento de seus aplicativos.

A documentação que estava disponível até agora não era exaustiva o suficiente para permitir que os desenvolvedores conhecer a API Sirena.

Com a nova atualização de documentação você pode saber mais sobre o que exatamente significa criar seu próprio App para a API Sirena, quais os benefícios que ele lhe traz; qual é a diferença entre criar seu próprio App vs conexão apenas através da API.

Também trazemos ferramentas úteis para eles da Sirena para melhorar o desenvolvimento dessas aplicações.

Para colocar a nova documentação de uma forma acessível a qualquer pessoa, adicionamos a nova seção do Help Center na página da Sirena.

Para quem está destinada essa documentação?

Esta ferramenta tem como alvo principalmente desenvolvedores (eles não precisam ser clientes Sirena) que desejam produzir uma solução que integre a plataforma Sirena com qualquer outra plataforma (Mercado pago,   Hubspot,   Stripe, Hotjar, ou aqueles que você pode pensar).

No entanto, a documentação foi criada para que quem quiser saber mais sobre os aplicativos da Sirena possa entrar e ler sobre ele. Para facilitar a compreensão da linguagem técnica, desenvolvemos um glossário para se referir se você tem dúvidas sobre qualquer termo.

Quais seções a nova documentação da Sirena inclui?

Resumidamente, a estrutura da documentação é composta da seguinte forma:

  • Getting started with Apps
  • Apps section
  • How to build your own App
  • App Developer Resources
  • HOW TOs

Getting started with Apps

Esta é a primeira seção dentro da Central de Ajuda. Você deve iniciar sua leitura nesta seção onde você encontrará os termos mais relevantes a considerar para o desenvolvimento e/ou para entender como o mercado funciona.

Dependendo do seu objetivo, a partir daí você pode ir para uma dessas duas seções:

  • Se você estiver interessado em saber mais sobre quais aplicativos são, você pode ir para a seção Aplicativos.
  • Se você está procurando construir seu próprio aplicativo para se integrar com o Sirena, você pode ir para a forma de construir sua própria seção de Aplicativos, que fala sobre os benefícios de se conectar com seu próprio aplicativo e lhe dá o link para ir à caixa de ferramentas Sirena (API,   pontos de extensão).

Apps section

Nesta seção você pode aprender como encontrar e instalar novos aplicativos, verificar o status de seus aplicativos instalados, configurá-los ou até mesmo desinstalá-los se você não usá-los mais.

Todos os tipos de usuários podem entrar nesta seção.

How to build your own App

Você encontrará os usos mais comuns para os quais integrações são desenvolvidas (sincronizando CRMs, relatórios personalizados,ações personalizadas que desencadeiam conversas, entre outros).

A partir daí você pode ir para a seção de ferramentas e recursos.

App Developers Resources

Você verá informações sobre pontos de extensão, relatórios, botões, campos de chumbo e campos de usuários.

HOW TOs

Incluímos pequenos trechos sobre como executar determinadas ações: como obter a chave de API, comocriar seu Manifesto de Aplicativos, como retornar publicasua integração, como importar pontos finais e informações para assinar Webhooks.

O que eu tenho que fazer se eu quiser integrar um aplicativo em Sirena?

Basicamente, para integrar um aplicativo ao Sirena, uma vez que você tenha desenvolvido o seu aplicativo, você deve criar o manifesto do App dele (é um documento que contém todas as informações relacionadas ao seu aplicativo, como o nome oficial, o logotipo, os pontos de extensão que você usou, qual escopo de API responde, etc).

Crie seu App manifiestr de forma ágil e simples, completando o formulário em nossa seção Como fazer.

Por outro lado, se você quiser tornar seu aplicativo público, você pode preencher um formulário adicional encontrado na mesma seção. Para este caso, você será solicitado alguns dados adicionais, como a URL do aplicativo, que versão é, etc.

Uma vez que você nos enviou toda a documentação relevante do aplicativo, nossa equipe de desenvolvedores vai revisar que tudo está em ordem e que a integração funciona com a plataforma Sirena. Quando eles aprovarem o seu aplicativo, ele já estará disponível no marketplace sirena.

No momento temos a documentação apenas em inglês, mas em breve estaremos compartilhando a documentação em outros idiomas!

Entre no Help Center e comece a incorporar ferramentas para criar suas próprias integrações.

Categorias:
Escrito por

Nahuel Gomez

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

Fique por dentro e confira as nossas dicas sobre o mercado mobile e interação digital.