Scriptcase API Overview
APIs allow you to integrate Scriptcase with external services, enabling the use of resources such as sending emails, SMS, payments, cloud storage, authentication, and reports.
In Scriptcase, these integrations can be configured through API profiles or used directly in applications with the help of specific macros.
APIs integrated with Scriptcase
| Category | Available APIs |
|---|---|
| SMTP, Mandrill | |
| SMS | Twilio, Plivo, Clickatell |
| Payment | Paypal, Pagseguro, MercadoPago, Braintree, Stripe |
| Storage | Amazon S3, Dropbox, Google Drive |
| Authentication | Google Authenticator |
| Reports | Google Sheets |
Click the desired API to access the corresponding documentation.
APIs can be used through the configuration of a profile, for use in resources such as the security module, or through the API manipulation macros.
Macros for use with APIs
| Category | Available macros |
|---|---|
| General | sc_call_api |
| 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 |
Profile management
API profiles allow you to store the configuration data of a specific API for use in Scriptcase projects.
The Scriptcase administrator can, for example, configure public API profiles so they can be used in all projects, without other developers having access to the configured account information.
When accessing the Tools > API menu, the list of API profiles visible to the user will be displayed, according to the mode in which they were created.
Profiles are grouped according to the availability mode defined during creation: 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 during creation, profiles can only be edited by users with administrator access in the project. See how to define the user access level in Scriptcase.
Management options
- Active - Allows you to enable or disable the API profile. Only active profiles will be available for use in the project.
- Edit - Opens the API configuration screen to change the profile data without changing its name. This way, it will not be necessary to modify the calls to this profile in settings or code.
- Delete - Permanently removes the API profile.