Limited time offers! Get up to 20% OFF.
  1. Home
  2. tools
  3. api

Scriptcase API Overview

APIs are a set of routines and standards established by a software program for the use of its functionalities.

In Scriptcase, it’s possible to integrate with various third-party applications through the APIs available in our tool. Check them out below.

APIs integrated with Scriptcase

| Categories | ||||| | :—————– | ———————- |-|-|-|-|-|

Email SMTP Mandrill  
SMS Twilio Plivo Clickatell    
Payment Paypal Pagseguro MercadPago Braintree Stripe
Storage Amazon S3 Dropbox Google Drive    
Authentication Google Authenticator
Reports Google Sheets

Click on the desired Gateway to access our API documentation.

These APIs can be used through profile configuration, for example, in the creation of a security module, or through API manipulation macros.

Macros for use with APIs

Categories Macros      
General sc_call_api      
Email sc_send_mail_api      
SMS sc_send_sms      
Storage sc_api_upload sc_api_download sc_api_gc_get_obj sc_api_gc_get_url

API Profile Management

API profiles allow developers to store configuration data for a specific API for use in their projects.

The Scriptcase administrator can, for example, configure multiple public API profiles to be used in all projects without other developers having access to the account information.

List of configured APIs

By accessing the menu Tools > API, you will see the list of API Profiles, visible to your user according to the mode in which they were created.

The profiles will be grouped according to the mode in which they were created: Project, Public or User.

The mode defines the availability of the Profile in Scriptcase.

  • Public - Users from all projects will be able to view and use the created profile.

  • Project - Users will be able to view and use the profile in the project where it was configured.

  • User - Only the user who created the profile will be able to view and use it in the applications.

Regardless of the mode used for creation, profiles can only be edited by users with administrator access in the project. [See how to define user access levels][link_nivel_acesso_sc]{:target=”_blank”} in Scriptcase.

Management options

List of configured APIs

  • Active - This flag allows the developer to activate or deactivate an API. Only active APIs will be available for use in the project.

  • Edit - Opens the API configuration screen to change the data, without needing to change the Profile name. This way, it will not be necessary to change the profile calls in its settings and code.

  • Delete - Permanently deletes the profile from the API.