API

Related links

API settings let you integrate the various APIs available into the Scriptcase. Through this interface it is possible to configure email sending, SMS and Online Payment APIs.

APIs List

On access you can view a list of all the APIs already configured.

• Name: Configured API Name.
• Geteway: Geteway used to send the email.

Email APIs

Scriptcase connects to three different APIs for sending emails: SMTP, Mandrill and Amazon SES.

SMTP Configuration

SMTP is the standard protocol for sending e-mails over the Internet, and each provider has its own SMTP.

For more information about SMTP settings click here

• API: Allows you to select an API that is already configured in Tools> API or set a new one here by selecting - custom -. In this case you will see some options according to the selected Gateway.
• Gateway: Select the way the e-mail is sent. In this case the SMTP is selected. SMTP is the default protocol for sending e-mails over the Internet, each provider has its own SMTP.
• SMTP Server: SMTP server address for the provider being used.
• Port SMTP: Port used by the mail server. Use port 465 for security with SSL, port 587 for security with TLS, or port 25 as port without security. By omitting the value the Scriptcase will default to: 25
• User SMTP: SMTP server user.
• Enter SMTP: SMTP server user password.
• Protocol SMTP: Defines the security protocol that will be used. If the value is omitted, the Scriptcase defaults to the default value.
• E-mail: Sets the origin email, which will send the emails.
• Name: Name that will be displayed in the sent email.

Mandrill Configurations

Mandrill is a transactional email API for MailChimp users, ideal for sending data-driven emails.

• API: Allows you to select an API that is already configured in Tools> API or set a new one here by selecting - custom -. In this case you will see some options according to the selected Gateway.
• Gateway: Select the way the e-mail is sent. In this case the Mandrill is selected. Mandrill is a transactional email API for MailChimp users, ideal for sending data-driven emails.
• API KEY: Enter the key you obtained when setting up your API.
• E-mail: Sets the origin email, which will send the emails.
• Name: Name that will be displayed in the sent email.

For more information about mandrill

Amazon SES Configurations

Amazon Simple Email Service Amazon SES is an email sending service designed to assist in sending marketing emails, notifications, and transactional messages.

• API KEY: Enter the key you obtained when setting up your API.
• API Secret: Enter the secret access key of your account.
• Region: Amazon SES has endpoints in several regions, in order to reduce network latency, inform the region of the endpoint closest to your application. See the regions.
• E-mail: Sets the origin email, which will send the emails.
• Name: Name that will be displayed in the sent email.

For more information about Amazon SES

SMS APIs

Scriptcase connects to different APIs for sending SMS text messages:

• Twilio
• Plivo
• Clickatell

Setting up Twilio API

Twilio is a set of libraries that enables SMS communication on a global scale. For correct configuration, we need to enter the data of Authentication ID, Authentication Token and Sender, as shown below:

• Name: Enter a name for your API;
• Gateway: Gateway to be used (in this case we use Twilio);
• Auth ID: Enter the authentication ID for your Twilio account;
• Auth Token: Enter the authentication Token for your Twilio account;
• From: Enter the sender’s number to send the SMS;

Setting up Plivo API

• Name: Enter a name for your API;
• Gateway: Gateway to be used (in this case we use Plivo);
• Auth ID: Enter the authentication ID of your Plivo account;
• Token ID: Enter the authentication Token of your Plivo account;
• From: Enter the sender number to send the SMS;

Setting up Clickatell API

• Name: Enter a name for your API;
• Gateway: Gateway to be used (in this case we use Clickatell);
• Auth Token: Enter the authentication Token of your Clickatell account;

Whatsapp APIs

We do use the ChatAPI for sending messages through WhatsApp.

Chat api

First, we should [access the ChatAPI website][get_token_chatapi]{:target=’blank’} where we will get the data needed for the API configuration in Scriptcase.

With the data in hand, go to the Tools> API menu to access the settings screen (as shown below in the image).

• Name - Defines the name that will identify the configured API. We recommend that the name is defined in a way that identifies the data used in the configuration, since it is possible to create more than one API with this Gateway, so it will be simpler to identify the API at the time of the call.
• Mode - Defines the access level of this API, which are: Public, where all users of all projects have access to this API; Project, where all users of this project have access to this API; Usuário, where only the user creating the API will have access to any project.
• Gatway - Defines the API that will be used. We must select Chat api.
• URL - URL required for or sending a message
• Auth Token - Enter Token generating in the settings of your API. [Visit the ChatAPI website to get your token.][get_token_chatapi]{:target=’blank’}

After the configuration of the APIs, we must use the macro macro sc_whatsapp (); where we must inform the other information to send the message.

Check the macro syntax below:

sc_send_whatsapp (['profile' => 'api_chatapi',
                   'message' => 'Message to be sent',
                   'to' => '558182499699']);

Payment APIs

It is possible to use APIs for online payment processing in Scriptcase. Integration with the following APIs is available:

• paypal

Setting up Paypal

• Name: Enter a name for your API;
• Gateway: Gateway to be used (in this case we use paypal_express);
• Username: User authentication of the PayPal account;
• Password: Password of authentication of the account Paypal;
• Signature: Signature of authentication of the Paypal account;
• Test Mode: Allows you to use the API as a test mode.