Feedback

API

Conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades. Visando facilitar a utilização de APIs no Scriptcase, foi criada uma interface que nos permite configurar e utilizar algumas APIs com o mínimo de código possível.

Lista de APIs

A tela inicial das APIs possui a lista com todas as APIs configuradas no projeto categorizadas pelo nível que em foram criadas.

Algumas opções para o gerenciamento das APIs também estão disponíveis:

  • Adicionar Novo - Permite configurar um nova API, após sua configuração é necessário ativar a API para sua utilização.
  • Ativo - Permite ativar ou desativar uma API no projeto. As APIs ativas serão exibidas para serem utilizadas de acordo com seu nível de permissão.
  • Editar - Permite editar as configurações da API desejada.
  • Excluir - Apaga as configurações da API desejada para todos os usuários com acesso.

Lista de APIs configuradas

APIs de envio de email

O Scriptcase conecta com três diferente APIs para envio de emails: SMTP, Mandrill e Amazon SES.

SMTP

O SMTP é o protocolo padrão para envio de e-mails através da Internet, cada provedor possui seu próprio SMTP.

Para Mais informações sobre as configurações do SMTP clique aqui

Configuração de envio

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Modo - Define o nível de acesso desta API, que são: Público, onde todos os usuários de todos os projetos têm acesso a esta API; Projeto, onde todos os usuários deste projeto terão acesso a esta API; Usuário, onde apenas o usuário criador da API terá acesso em qualquer projeto.
  • Gateway: Selecione a forma de envio do e-mail. Neste caso, está o SMTP está selecionado. O SMTP é o protocolo padrão para envio de e-mails através da Internet, cada provedor possui seu próprio SMTP.
  • Servidor SMTP: Endereço do servidor SMTP referente ao provedor que está sendo utilizado.
  • Porta SMTP: Porta utilizada pelo servidor de e-mail. Utilize a porta 465 para segurança com SSL, a porta 587 para segurança com TLS ou a porta 25 como porta sem segurança. Ao omitir o valor o Scriptcase assumirá o valor default: 25
  • Usuário SMTP: Usuário do servidor SMTP.
  • Senha SMTP: Senha do usuário do servidor SMTP.
  • Protocolo SMTP: Define o protocolo de segurança que será utilizado. Ao omitir o valor o Scriptcase assumirá o valor padrão sem segurança.

  • Do e-mail: Define o e-mail de origem, que enviará os e-mails.
  • Do Nome: Nome que será exibido no e-mail enviado.

Mandrill

O Mandrill é uma API de e-mail transacional para usuários do MailChimp, ideal para enviar e-mails orientados por dados.

Configuração de envio

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • API: Permite selecionar uma API já configurada em Ferramentas > API ou configurar aqui selecionando -personalizadas-. Neste caso serão exibidas algumas opções de acordo com o Gateway selecionado.

  • Gateway: Selecione a forma de envio do e-mail. Neste caso, está o mandrill está selecionado. O Mandrill é uma API de e-mail transacional para usuários do MailChimp, ideal para enviar e-mails orientados por dados.
  • Chave API: Informe a chave obtida ao configurar o sua API.

  • Do e-mail: Define o e-mail de origem, que enviará os e-mails.
  • Do Nome: Nome que será exibido no e-mail enviado.

Para mais informações sobre o mandrill

Amazon SES

Amazon Simple Email Service (Amazon SES) é um serviço de envio de e-mail criado para auxiliar no envio de e-mails de marketing, notificações e mensagens transacionais.

Configuração de envio

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Chave API: Informe a chave obtida ao configurar o sua API.
  • API Secret: Informe a secret access key de sua conta.
  • Região: O Amazon SES possui endpoints em várias regiões, com o intuito de reduzir a latência da rede, informe a região do endpoint mais próxima do seu aplicativo. Veja as regiões.

  • Do e-mail: Define o e-mail de origem, que enviará os e-mails.
  • Do Nome: Nome que será exibido no e-mail enviado.

Para mais informações sobre o Amazon SES

APIs de envio de SMS

O Scriptcase conecta com diferentes APIs para envio de mensagens de texto SMS. São elas:

Configurando envio por Twilio

Twilio é um conjunto de bibliotecas que permite comunicação por SMS em escala global. Para correta configuração, precisamos informar os dados de ID de autenticação, Token de autenticação e Número remetente, conforme imagem abaixo:

Configuração de envio utilizando API Twilio

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Gatway - Define a API que será utilizada. Devemos selecionar Twilio.
  • ID de Autenticação: Informe o ID de autenticação de sua conta Twilio;
  • Token de Autenticação: Informe o Token de autenticação de sua conta Twilio;
  • De: Informe o número remetente para o envio do SMS;

Configurando envio por Plivo

Configuração de envio utilizando API Plivo

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Gatway - Define a API que será utilizada. Devemos selecionar Plivo.
  • ID de Autenticação: Informe o ID de autenticação de sua conta Plivo;
  • Token de Autenticação: Informe o Token de autenticação de sua conta Plivo;
  • De: Informe o número remetente para o envio do SMS;

Configurando envio por Clickatell

Configuração de envio utilizando API Clickatell

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Gatway - Define a API que será utilizada. Devemos selecionar Clickatell.
  • Token de Autenticação: Informe o Token de autenticação de sua conta Clickatell;

APIs de envio pelo Whatsapp

O Scriptcase utiliza a ChatAPI para envio de mensagens pelo Whatsapp:

Chat api

Primeiramente, devemos acessar o site da ChatAPI onde iremos obter os dados necessários para a configuração da API no Scriptcase.

Com os dados em mãos, acesse o menu Ferramentas > API, para ter acesso a tela de configurações(como mostrado abaixo na imagem).

Interface de configuração da API de envio de mensagens no Whatsapp, Chat API, no menu Ferramentas do Scriptcase

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Modo - Define o nível de acesso desta API, que são: Público, onde todos os usuários de todos os projetos têm acesso a esta API; Projeto, onde todos os usuários deste projeto terão acesso a esta API; Usuário, onde apenas o usuário criador da API terá acesso em qualquer projeto.
  • Gatway - Define a API que será utilizada. Devemos selecionar Chat api.
  • URL - URL requerida para o envio da mensagem.
  • Auth Token - Informe o Token gerando nas configurações de sua api. Acesse o site da ChatAPI para obter seu token.

Após a configuração da API, devemos utilizar a macro macro sc_whatsapp(); para o envio das mensagens.

Confira abaixo a sintaxe da macro:

sc_send_whatsapp([ 'profile'=> 'api_chatapi',
                   'message' => 'Mensagem',
                   'to' => '5511955554444']);

APIs de pagamento

É possível a utilização de APIs para processamento de pagamentos Online no Scriptcase. Estão disponíveis integração com as seguintes APIs:

Configurando pagamento por Paypal

Configuração de pagamento utilizando API Paypal

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Gatway - Define a API que será utilizada. Devemos selecionar paypal_express;
  • Usuário: Usuário de autenticação da conta Paypal;
  • Senha: Senha de autenticação da conta Paypal;
  • Assinatura: Assinatura de autenticação da conta Paypal;
  • Modo de teste: Permite utilizar a API como modo de teste.

Configurando pagamento por Pagseguro

Configuração de pagamento utilizando API Pagseguro

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome - Define o nome que irá itentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.
  • Gatway - Define a API que será utilizada. Devemos selecionar pagseguro;
  • Ambiente: Especifica o tipo de ambiente a ser utilizado (sandbox ou produção);
  • Email de Autenticação: Email de autenticação da conta pagseguro;
  • Token de Autenticação: Token de autenticação da conta Pagseguro;
  • Charset: Charset a ser utilizado para troca de informações com a API;
  • Auth AppID: ID de autenticação da aplicação;
  • Auth AppKey: Chave de autenticação da aplicação.

APIs de Storage

O scriptcase disponibiliza 3 APIs para este tipo de serviço. Funciona apenas em campos do tipo: imagem (nome da imagem) e documento (nome do documento).

  • Dropbox
  • Google Drive
  • S3

Dropbox

Dropbox é um serviço para armazenamento e partilha de arquivos. É baseado no conceito de “computação em nuvem”. Ele pertence ao Dropbox Inc., sediada em San Francisco, Califórnia, EUA. A empresa desenvolvedora do programa disponibiliza centrais de computadores que armazenam os arquivos de seus clientes.

Para saber como configurar a sua chave de API clique aqui

Configuração de API Dropbox

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome: Define o nome que irá ditentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.

  • Modo: Define o nível de acesso desta API, que são: Público, onde todos os usuários de todos os projetos tem acesso a esta API; Projeto, onde todos os usuários deste projeto teram acesso a esta API; Usuário, onde apenas o usuário criador da API terá acesso em qualquer projeto. (Aconselhável para esta API o nível de projeto).

  • Gateway: Define a API que será utilizada. Devemos selecionar Dropbox.

  • Chave API: Informe a chave obtida ao configurar o sua API.

  • API Secret: Informe a secret access key de sua conta.

  • Token de acesso: Informe o Token de acesso gerado na sua conta Dropbox

Google Drive

O Google Drive é um serviço de disco virtual lançado pela Google. O serviço permite o armazenamento de arquivos na nuvem do Google.

Para saber como configurar a sua chave de API clique aqui

Configuração de API Google Drive

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Nome: Define o nome que irá ditentificar a API configurada. Aconselhamos que o nome seja definido de forma que permita identificar os dados utilizados na configuração, já que é possível criar mais de uma API com este Gateway, desta forma ficará mais simples identificar a API no momento da chamada.

  • Modo: Define o nível de acesso desta API, que são: Público, onde todos os usuários de todos os projetos tem acesso a esta API; Projeto, onde todos os usuários deste projeto teram acesso a esta API; Usuário, onde apenas o usuário criador da API terá acesso em qualquer projeto. (Aconselhável para esta API o nível de projeto).

  • Gateway: Define a API que será utilizada. Devemos selecionar Google_drive.

  • Nome do aplicativo: Nome do aplicativo que será usado.

  • Json OAuth: Informe o conteúdo do arquivo de autenticação do usuário gerado.

  • Código de autenticação: Informe o código de identificação obtido ao configurar sua API.

Amazon S3

O Amazon Simple Storage Service (Amazon S3) é um serviço de armazenamento de objetos que oferece escalabilidade líder do setor, disponibilidade de dados, segurança e performance. Isso significa que clientes de todos os tamanhos e setores podem usá-lo para armazenar qualquer volume de dados em uma grande variedade de casos de uso, como sites, aplicações para dispositivos móveis, backup e restauração, arquivamento, aplicações empresariais, dispositivos IoT e análises de big data.

Para saber como configurar a sua chave de API clique aqui

Configuração de API Amazon S3

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

  • Chave API: Informe a chave obtida ao configurar o sua API.

  • API Secret: Informe a secret access key de sua conta.

  • Região: O Amazon SES possui endpoints em várias regiões, com o intuito de reduzir a latência da rede, informe a região do endpoint mais próxima do seu aplicativo.

  • Bucket: Informe a bucket para ser armazenados arquivos no Amazon S3.

APIs de Autenticação - Google authenticator

Esta API de autenticação do google permite a criação de sistemas mais seguros com a utilização de autenticação de duas etapas.

Para utilização desta API é necessário a instalação do aplicativo Google Authenticator em seu dispositívo móvel.

Interface de configuração da API autenticação do google

Para utilizar uma API em um projeto publicado é necessário realizar a configuração desta API no ambiente de produção, no menu API.

Para a configuração da API Devemos informar:

Nome

Utilizado apenas para identificação da API dentro da ferramenta.

Mode

Esta opção define a disponibilidade da API dentro do Scriptcase. As opções de configuração são:

  • Público - Com esta opção todos os projetos e usuários da ferramenta terão acesso a esta API para utilização.
  • Projeto - Ao salvar a API à nível de projeto, todos os usuários do projeto terão acesso a esta API para utilização.
  • Usuário - Apenas o usuário que realizou a configuração da API terá acesso para sua utilização em qualquer projeto.

A recuros so poderá ser editado no projeto onde foi criado, independente do modo de salvamento escolhido.

Gateway

Define a API de autenticação que será utilizada.

Domain

Define o domínio habilitado para a utilização da autenticação de duas etapas.

Exemplos:

  • myscriptcase.com.br
  • 127.0.0.1

Devemos informar apenas um domínio para utilização da API.