Como criar uma chave pública de API na systeme.io

Neste artigo, você vai aprender como configurar e usar a API pública da systeme.io, incluindo como gerar chaves de API e quais ações você pode realizar.

1. O que é uma API?

A sigla API significa "Application Programming Interface" (Interface de Programação de Aplicações), uma série de instruções por meio das quais uma plataforma oferece serviços a outras plataformas. É uma porta de entrada estratégica para desenvolvedores externos, permitindo que eles acessem funcionalidades ou dados específicos de uma plataforma de forma estruturada e segura. É como um conjunto de ferramentas prontas para uso que facilita a criação de novos aplicativos, serviços ou integrações.

Em resumo, a systeme.io se abre para outras plataformas para oferecer seus serviços, onde agrega valor.

2. Como funciona nossa API pública?

Nossa API disponibiliza um conjunto de recursos cuidadosamente selecionado, permitindo que os desenvolvedores interajam com nossa plataforma de forma transparente e eficiente. Se quiser saber mais sobre como ela funciona, você pode consultar nossa documentação oficial da API.

3. Como gerar suas chaves de API

As chaves de API são identificadores exclusivos que autenticam as solicitações à nossa API pública. Elas permitem que você acesse e gerencie de forma programática vários recursos em nossa plataforma.

Para conectar uma integração externa, primeiro você precisa gerar uma chave de API segura. Acesse sua foto de perfil e selecione Configurações (1). No menu à esquerda, clique em MCP e chaves de API (2).

Desça até a seção Chaves públicas da API e clique em Criar (3).

Dê um nome à sua chave, defina uma data de validade e clique em Salvar (4).

Observação: para manter sua chave de API ativa por tempo indeterminado, deixe o campo "Data de expiração" vazio.

Agora sua chave está pronta.

4. O que você pode fazer com nossa API?

Nossa API oferece diversas possibilidades. Abaixo estão as principais ações que você pode realizar usando nossa API pública:

a. Gerenciamento de contatos, tags e campos personalizados:

• Contatos: Crie novos contatos, atualize os existentes, liste seu público usando filtros avançados ou exclua contatos.

• Tags: Crie, atribua, liste e remova tags dos contatos.

• Campos personalizados: Consulte os campos de formulário personalizados e seus identificadores (slugs) para preencher corretamente as informações dos contatos.

b. Gerenciamento de newsletters e campanhas:

• Newsletters: Crie novos rascunhos, atualize os existentes, segmente públicos (usando tags de inclusão/exclusão), configure os dados do remetente, agende ou remova agendamentos, envie emails de teste, envie newsletters diretamente, exclua rascunhos e recupere newsletters específicas.

• Campanhas: Crie, recupere, atualize e exclua campanhas de email inteiras, bem como etapas individuais das campanhas.

c. Gerenciamento de funis e editor de páginas:

• Criação de funis, etapas de inscrição e funis de webinar: Crie facilmente novos funis, adicione etapas de inscrição aos seus funis e crie funis de webinar com todas as etapas necessárias, incluindo páginas de inscrição, agradecimento e transmissão do webinar.

• Listagem e recuperação de funis: Consulte seus funis, etapas de inscrição e páginas de webinar existentes ou pesquise por itens específicos.

• Nova geração de conteúdo (páginas de webinar): Gere novamente o conteúdo completo de uma página de webinar.

• Editor de páginas: Salve o conteúdo de página gerado diretamente nas etapas do seu funil ou nas páginas do seu site (substituição completa), recupere esquemas JSON para tipos específicos de páginas e gere novamente o conteúdo de páginas de webinar.

Observações:

• Atualmente, não é possível modificar (editar) funis e etapas de funis por meio do MCP.

• A exclusão de funis, etapas de funis e páginas de webinar por meio do MCP também não é compatível no momento.

• A IA pode regenerar o conteúdo de uma página de webinar substituindo todo o conteúdo, mas pequenas alterações direcionadas ainda não são compatíveis.

d. Gerenciamento de preços e cupons:

• Criação, edição e exclusão: Gere novos preços e cupons ou atualize parcialmente e exclua os existentes.

• Listagem e pesquisa: Consulte todos os seus preços e cupons existentes ou recupere itens específicos pelo ID.

e. Gerenciamento de cursos e alunos:

• Cursos e alunos: Crie, edite configurações, exclua, liste, recupere, ative e desative cursos. Liste os modelos de páginas de cursos e escolha um tema para o curso. Recupere uma lista dos seus cursos existentes e uma lista dos alunos atualmente matriculados.

• Módulos: Crie, edite, exclua, liste e recupere módulos.

• Aulas: Crie, edite, exclua, adicione atrasos, habilite comentários, liste, recupere, ative e desative aulas.

• Inscrição de alunos: Inscreva contatos em seus cursos individuais.

Observação sobre cursos: O suporte a pacotes de cursos será adicionado em atualizações futuras.

f. Gerenciamento de comunidades:

• Comunidades: Recupere uma lista das suas comunidades existentes e acesse uma lista dos membros atuais de uma comunidade específica.

• Convite de membros: Convide novos usuários para participar de suas comunidades, fornecendo o ID do contato.

g. Gerenciamento de regras de automação:

• Regras de automação: Conecte facilmente eventos e ações comuns sem precisar configurá-los manualmente no seu painel. Atualmente, você pode criar regras usando os seguintes gatilhos: Tags (Tag adicionada, Tag removida), Cursos (Inscrito no curso, Curso concluído, Aula concluída, Módulo concluído), Vendas (Falha no pagamento da assinatura, Nova venda, Venda cancelada), Inscrito na etapa de formulário do funil, Campanha concluída, Reunião agendada e Página visitada. E as seguintes ações: Tags (Adicionar uma tag, Remover uma tag), Cursos (Inscrever no curso, Revogar acesso ao curso), Cancelar inscrição na campanha, Enviar webhook e Enviar SMS.

• Listagem e recuperação: Consulte suas regras de automação ou recupere uma regra específica pelo ID.

h. Gerenciamento de assinaturas:

• Assinaturas: Recupere uma lista de todos os recursos de uma assinatura de plataformas de terceiros e cancele uma assinatura imediatamente ou no final do ciclo de cobrança.

i. Gerenciamento de webhooks:

• Crie novos webhooks para receber notificações em tempo real, recupere listas dos seus webhooks existentes e remova webhooks que não são mais necessários.

j. Gerenciamento de produtos digitais:

• Criação, visualização, atualização e exclusão: Gerencie totalmente seus produtos digitais.

• Listagem e pesquisa: Consulte seus produtos digitais existentes ou pesquise por produtos específicos.

• Vinculação de preços: Crie ou vincule preços diretamente aos seus produtos digitais.

• Conexão com fluxos de venda: Conecte produtos digitais aos seus fluxos de venda (checkout, upsells e downsells).

k. Gerenciamento de produtos físicos:

• Criação, visualização, atualização, recuperação e exclusão: Gerencie totalmente seus produtos físicos.

• Conexão com fluxos de venda: Conecte produtos físicos aos seus fluxos de venda (checkout, upsells e downsells).

l. Gerenciamento de ofertas e configurações de vendas:

• Criação e configuração de ofertas: Configure ofertas para seus fluxos de venda, como checkout, upsells e downsells.

• Gerenciamento das configurações de vendas: Configure definições detalhadas para suas ofertas, incluindo cupons, order bumps, moeda, métodos de pagamento, configurações de impostos, comissões de afiliados, atrasos de pagamento e limites de vendas. Você também pode vincular facilmente seus produtos digitais e físicos diretamente a essas ofertas.

m. Gerenciamento de agendamentos:

• Criação, atualização e exclusão de eventos: Crie novos eventos na agenda ou modifique e exclua facilmente os existentes.

• Listagem e pesquisa de eventos: Recupere uma lista dos seus eventos da agenda ou pesquise eventos específicos pelo nome.

• Recuperação de detalhes dos eventos: Recupere todos os detalhes de um evento específico, incluindo seus locais, disponibilidade, fuso horário, período e lembretes.

• Listagem e filtragem de agendamentos: Recupere uma lista dos seus agendamentos e filtre-os por evento, status e período.

Observação sobre eventos da agenda: Atualmente, não é possível atualizar o tipo de um evento da agenda existente por meio do MCP.

n. Gerenciamento de templates de SMS:

• Listagem e pesquisa: Recupere uma lista dos seus templates de SMS existentes ou pesquise templates específicos.

Observações:

1. Para identificar e gerenciar suas chaves facilmente, cada uma deve ter um nome exclusivo.

2. Uma chave só pode ser copiada imediatamente após sua criação. Se você se esqueceu de copiar sua chave, exclua-a e crie uma nova.

3. Como medida de segurança, enviaremos uma notificação por email sempre que uma nova chave pública de API for criada em sua conta da systeme.io.

4. Você pode criar até 3 chaves de API por conta.

Saiba mais: Documentação da API.