Documentation

The dashboard is the central place from where you control all your instances. Use this tool to:

    Request a secure instances. We set one up for you in minutes.


    Manage and configure your instances.


    Monitor alerts and servers statistics.

Each server you start has the API Builder Tool pre-installed on it. Use this GUI tool create powerful API without any coding.

    User management - login, profiles, networking, custom data.


    Credit card processing, shopping carts.


    Send Emails, SMS, and Push Notifications.


    Share files - Documents, images, videos, audio files.

This examples video shows an overview of the API Builder tool and demonstrates how to create a sample API.

    Create a variable and display it via an API.


    Save and Publish the API.


    Test the API.

This examples video demonstrates how to declare variables and perform operations.

    Read input variables.


    Perform math operations.


    Save, Publish and Test the API.


This examples video demonstrates how to insert a record into the database.

     Insert a record from the database.


      Use the Wizard to create API.


     Save, Publish and Test the API.

An Android, iOS or web app, is made up of two main components:

  • Front End - The front end is what your users see and interact with.
  • Back End Server - The back end server is used to store and share data between users, process credit cards, send SMS, Emails and Push Notification etc.

logo img


The front end and backend exchange information using APIs. For example if an app user wants to share an update with other app users, the update is first sent to the server via an API call. Next, the app on the other users’s device pulls the information from the server using another API.

The current standard for API communication is JSON.

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write, and easy for machines to parse and generate.

A JSON response is mainly a key value pair:

  • Key - A key is always a string enclosed in quotation marks.
  • Value - A value can be a string, number, array, or object.
  • Key/Value Pair - A key value pair follows a specific syntax, with the key followed by a colon followed by the value. Key/value pairs are comma separated.


For example:

                          
                              “name” : “Bob”
                          
                      


This is an example of a key/value pair where “name” is the key and the value is “Bob”.

JSON supports various types of values:
  • Number : An integer.

  • String : Several plain text characters which usually form a word or sentence.

  • Object : An associative array of key/value pairs.
    • An object is an unordered set of name/value pairs. It begins with { (left brace) and ends with } (right brace). Each name is followed by : (colon) and the name/value pairs are separated by ',' (comma).

  • Array : An associative array of values.
    • An array is an ordered collection of values. It begins with [ (left bracket) and ends with ] (right bracket). Values are separated by , (comma).


A complete JSON structure is easy to read. For example:

                          
                  {
                      "name": “Joe Smith",
                      "age" : 28,
                      "pets": [
                                 {"type": “dog”, “name”: “Shadow”},
                                  {"type": “cat”, “name”: “Snickers”}
                               ]
                  }
    
                          
                      

Here “pets” is an array of two objects. Each object has two attributes: “type” and “name”.

For more information on JSON, visit http://www.json.org/

To get started with Axis API, go to axisapi.com and create a user for yourself. Once you login into axisapi.com, you can access our helpful tutorial videos.

axisapi.com works with most modern browsers. For best results, it is recommended that you use Chrome.

When you are ready to start your own server, click on Dashboard menu option. This is where you can start new instances and maintain them.


logo img

To start a new instance, click on the “New Instance” button. This will open a window where you enter the name of the instance and choose the type of the instance you need.

Complete the steps to request your very own servers. Once the request has been successfully submitted, click on the “Refresh” button on the top right of the “Dashboard” page.

Once your server is setup, you will get an email with the details. This usually takes 10 to 15 minutes. To make sure you receive email notifications, add “info@axisapi.com” to your list of contacts. Check you Span/Junk email folders in case you did not receive a notification.

Once you receive the email notification, re-login into axisapi.com or click the “Refresh” button.

In the “Your Instances” section, you will see all your instances. Clicking on the “Show Details” button for an instance shows the details for that instance below.

Axis API provides you with your very own virtual private server. This server is completely customizable as per your needs.

To setup your instance, click on the “Show Details” button next to it in the “Your Instances” section. In the section below, you the instance details section that looks something like this:


logo img

This is the first think you do once you get a new instance. This will setup a password for the two applications that are pre-installed on your instance:

  • API Builder Tool

  • Database Adminer Tool

More information about the API Build brand the Database Adminer Tool below.

If you wish to send SMS messages to your customer for activities like password resets, urgent notifications etc, you can do it using Twilio. Twilio is a market leader in SMS messaging services. To enable you app, create an account with twilio.com to get twilio credentials.

Enable SMS on your app by inputing the following information:

  • Twilio Account ID

  • Twilit Authorization Token

  • Twilio Phone Number

More information on how to design APIs that send SMS messages is discussed in another section below.


Google’s Cloud Messaging (GCM) is Google’s solution for sending Push Notifications to:

  • Android Devices

  • iOS Devices

  • Chrome Web Applications.

If you wish send Push Notifications to these devices, create an account with GCM and setup our instance by providing this information:

  • GCM Authorization Key


If you wish to send Push Notifications to iOS Devices and you do not want to use Google for it, you can using it using Apples APN Service discussed next.

More information on how to design APIs that send Push Notification is discussed in another section below.

If you are building an iOS App and do not wish to use GCM, you can use Apple Push Notification Service (APN Service) instead. APN Service is a platform created by Apple Inc. that enables your apps to receive Push Notifications.

To setup for app to receive Push Notifications, create and download the Certificate file and choose a password for it on apple developer.apple.com.

To setup your instance for Push Notifications using APN, upload the Certificate and input the password for it.

More information on how to design APIs that send Push Notification is discussed in another section below.

If you are creating a web app or are building a landing page for your app, you do not need a separate server for it. You can use your axisAPI instance to host these web pages. Code you may choose to host on your instance include:

  • HTML

  • CSS

  • Javascript etc.


To load the code on your instance, simply compress all your files into a .zip archive file. This .zip archive file can now be uploaded onto your instance using this option.

Once the file is uploaded, it will be uncompressed and installed in the HTML root directory.

Your code can now be used on the web.

Your instance comes pre-installed with the API Builder Tool. To secure the API Builder Tool, remember to set the password using the “Password” button for the instance.

The API Builder Tool is a powerful and yet easy to use GUI Tool that you use to design, test and publish your APIs. The API Builder Tool allows you to build complex APIs without having to ever write traditional code.

This option shows you your API Builder URL for the instance. You can access the API Builder Tool from here or you can bookmark the URL and access it directly also.

For more information on the API Builder Tool, check out the chapter dedicate to it.

Your axisAPI instance comes pre-installed with a MySQL Relational Database. To secure the Database “Adminer" Tool, remember to set the password using the “Password” button for the instance. The user name for the database is “axis” and the database schema is named “mydb”.

Using the Database “Adminer" Tool, you have full access to your data. You can performa all standard operations using this tool:

  • Create/Alter Tables.

  • Import/Export Data.

  • Analyze the data by running standard SQL Queries ( SELECT Statements).

  • Improve performance by managing indexes, primary keys etc.



You app can access your instance over the web. To access your instance, you need the public DNS for the instance.

This option shows you the URL you can use to access your instance over the HTTP protocol.

If you wish to secure your API calls and call your APIs over the Secure HTTPS protocol, you need to setup a SSL Certification on the instance. We provide you with a free SSL Certificate that you can setup using the “Security” option.

Details on how to setup your SSL Certificate on the instance are discussed in the “Security” option.

Once you have successfully setup an SSL Certificate on your instance, the “Endpoint” option will also show you the public DNS which you can use over the HTTPS protocol. You need to use this public DNS to create a CNAME record with your domain provider. Once that is done, you can now calls API over a URL that looks like:

                          
                      https://www.mydomain.com:8443/MainPage?…..


We understand that data is one of your most valuable assets. You can manually take a backup any time by exporting your data using the Database Adminer Tool. Alternately, we can take regular daily backups for you.

Use the “Backup” option to setup automatic backups of you instance. We take a backup on your behalf and store it on an AWS S3 Bucket of your choice.

Use this option to setup your daily backups by providing the following information:

  • AWS S3 Bucket Name.

  • AWS Access Key ID.

  • AWS Secret Access Key.

  • AWS S3 Region.




We understand that data is one of your most valuable assets. To access your APIs over the Secure HTTPS Protocol, first procure a domain of your choice.

In the Security option’s first step, enter the name of your domain - eg www.somedomain.com. This will send you an email. The email has a link embedded it in. Please click on the link to open a web page. This web page has a button titled “I Agree”. All you need to do next is click on the “I Agree” button. Once this action has been performed, click on “Refresh” button. If you did not receive the email, click on the “Re-Send Email” button.

When you click on “Refresh” after approving the email, you will see the “Validation Successful” step. Here click on “Next Step” to initiate SSL installation step.

Once the setup is completed, you will receive an email with the new secure Endpoint. You can always access the new secure endpoint using the “Endpoint” option.

Use your domain provider (eg, goDaddy) to create a CNAME record for the new endpoint. Once successfully setup, you can not access the new endpoint by referring to it by your domain name over https protocol. For example:

                          
                  https:mydomain.com:8443:/MainPage?..
                          
                      

If due to an unforeseen situation, you need to restart your instance, you can use this option.

Please remember to take a backup before you performa this activity if possible.

Once you are done using your instance, you can always delete the instance. Please remember to take a backup of your code and data before you delete an instance.

When an instance is deleted, we will will refund the unused period for the instance.

Please remember to take a backup before you performa this activity.

The API Builder tool is used to build, maintain and test your APIs.

To login into the API Builder Tool, go to the Dashboard menu option. All your instances are listed in the “Your Instances” section. Click on the “Show Details” button next to the instance you want to work on. In the section below, click on the “API Builder” button. Next, click on the “Go” button. It will open the API Builder Tool for that instance in another tab of your browser. To login into your API Builder, enter the email address you used to login into axisapi.com and the password you set for the instance using the “Password” button for the instance.

The API Builder Tool has these 4 main sections:

  • Top Menu.

  • Project Area on the left.

  • Canvas Area in the center.

  • Properties Area on the right..


The Project, Canvas and Properties area separated by two vertical bars that can be dragged to adjust the size of the area. In the middle of the of the vertical bars, there is a small darker area that turns yellow when you bring your mouse over it. Click on it snaps the vertical bars to the side. To restore, simply click on that area again.

The top menu has a few icons:

logo img

Save Icon
Use this icon to save your work onto the instance.

Publish Icon
When you click on the Publish Icon, the APIs you designed will be picked up by the server and brought to life.

Database Icon
This icon is a shortcut to opens the Database Adminer Tool. It is similar clicking not he “Database” button for the instance.

Wizard Icon
Once you have created the tables you need using the Database Adminer Tool, you are now ready to build your APIs. The Wizard helps build a skeletal API to insert, update, delete data from the database. You can then customize, save, publish and test these APIs.

The Wizard is a great way to get you first few API build quickly.

Download Icon
The designs you build on your instance can be downloaded to your desktop. Once downloaded, you may use a source control system of your choice to save it or you may upload it to another instance if needed.

This is great for you want to test your design on your development instance and when done, upload it to your production instance.

Upload Icon
Use the Upload Icon to upload the API designs that you previously dowloaded using the Download Icon.

Uploading files will replace all your existing API on the instance with the new set in the file you are uploading.

The Project Area has three tabs:

APIs Tab

In this tab, you can add new API and select an API to edit/test.

To add a new API, click on the “Add API” Button.

To edit an API, simply click on the API and it will be opened up in the Canvas Area for editing.

You can Duplicate or Delete and API right click on the API name and a context sensitive menu will pop-up. To get rid of this pop-up menu, click on the “x” button.

Format Tab

The Format Tab, you can add and edit Formats.

Formats are used to create Structures and Arrays. More information about it in the Create Structure and Create Array Steps described in the next chapter.

To add a new Format click on the “Add Format” button.

To get a quick view of an existing Format, click on the “+” icon next to the format name. This will expand the format and show the names of the elements in format. The badge to the right of the element name shows you the type of the element. The badge is one of these three values:

  • A - The element is a string.

  • 9 - The element is a whole number.

  • $ - The element is a decimal number.


To edit the format, click on the format name. This will open the “Edit Format” modal. Here you can add or delete elements, modify the element type and element order.

To delete or duplicate a format, right click on the name of the format. A pop-up menu will show up. To get rid of the pop-up menu, click on the “x” button.

Functions Tab

The functions tab is where you define global functions that are usable by any API. Each API can have it’s own local function in the Canvas area which is the section below.

Define actions that need to be performed multiple times as global functions. For example, actions like check login, send SMS, send Email, send Push Notifications etc.

Adding, editing and management of the functions in the Functions tab is similar to how you manage APIs.

The Canvas Area is where you edit APIs, global functions and functions local to the API. Click on any API or global function you wish to open it up in the Canvas Area.

The first tab in the canvas is the name of the API or global function being edited. Additional tabs can be added by clicking on the “Add Function” button. Functions added by clicking on the “Add Function” button in the canvas area are available only within the current API. They are not available to other APIs.

To add steps click on the “Add Step” button. This will open a model from which you can pick the step type you wish to add. The API Builder has a wide variety of steps that you can use including declarations, Math operations, string operations, database operations and much more. See the chapter on “API Builder Step Types” for more details.

Each step added in the canvas areas shows up as a line. You can highlight a step by clicking on the it. The highlighted step is colored light purple. For example:

logo img

Each line has these components (from left to right):

  • An Up-Down Arrow. You can change the order of the steps by moving the mouse over this icon. The mouse cursor will change to a hand. Now you can click on the icon and drag the step up or down.

  • Name of the step type.

  • Small description of what the step performs.

  • A bullhorn icon is display if you have have defined the result of the step to be an output in the API response.

  • The trash icon. Use this icon to delete a step.


When a step is clicked on and highlighted, the details of the step are displayed in the the Properties area for editing.

When a step is highlighted in the canvas area, it’s details are displayed in the Properties area. Here, you can make changes and click on the “OK” button to update the Canvas area. Remember, the API is still not saved on the instance. To save the API permanently on the instance, you will still need to click on the “Save” button in the top menu.

The Properties Area has these sections (top to bottom):

  • The trash icon. Use this icon to delete a step.

  • On the top it has the step type. For example “STRING”

  • Below it, for most step types, there is an output or result box followed by a line below it. For example, “Variables”

  • Next, the step may have one or more parameters. For example, in this case, “Value”

  • Some steps have an “Output” dropdown. If you wish to define the result of the step as one of the output of your API, select “Yes” from the dropdown.

  • The OK button updates the canvas area with the changes you made in the properties area.

  • Lastly, there is a help section. This is a quick reference for the step type.



logo img

Each instance that is started comes with a set to out of the box APIs to jump start your project. These APIs can be used to :

  • Create New Users

  • Login/Logout

  • Manage user profile - Profile Picture, Name, Address, Location.

  • User Management - Reset Passwords

  • User Communication - SMS, Email, Push Notifications.

  • Social Networking - Send invites (friend requests), connect uses, send messages between connected users.


You have the full power for the API Builder Tool to modify these API or create new ones as needed.

This API is used to create a new user in the database. The current version makes sure User is unique by email address.

Input:

Element Name Description Type Example
emailAddressA well formatted email addressCHAR(60)joe@aol.com
userPasswordUser’s PasswordCHAR(30)Pass1234
deviceType[ Optional] A=Android, I= iOS. Defaults to A if nothing is passedCHAR(1)A
deviceTokenIThe Device Token ID from CGM or APICHAR(500)
AXIS_APITell the backend the API you want to invokeCHAR(50)UserAdd

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage": ""
    "tokenID": "ABCDCADAD12ADAD",
    "customerID": 1212
} 


This API is used to login an existing user. The API returns two attributes tokenID and customerID that are used by other APIs for authentication.

Input:

Element Name Description Type Example
emailAddressA well formatted email addressCHAR(60)joe@aol.com
userPasswordUser’s PasswordCHAR(30)Pass1234
deviceType[ Optional] A=Android, I= iOS. Defaults to A if nothing is passedCHAR(1)A
deviceTokenIDThe Device Token ID from CGM or APICHAR(500)
AXIS_APITell the backend the API you want to invokeCHAR(50)Login

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage": ""
    "tokenID": "ABCDCADAD12ADAD",
    "customerID": 1212
} 


This API is used to logout a user.

Input:

Element Name Description Type Example
tokenIDUsers Token IDCHAR(60)ABCDCADAD12ADAD
customerIDThe Customer’s IDNUM(9)1213
deviceType[ Optional] A=Android, I= iOS. Defaults to A if nothing is passedCHAR(1)A
deviceTokenIDThe Device Token ID from CGM or APICHAR(500)
AXIS_APITell the backend the API you want to invokeCHAR(50)Logout

Sample Output:

 
{
    "returnStatus": "SUCCESS",
} 


Login a user using Facebook. To use this, you will need to.

  • Create an app on Facebook - This is a simple form.

  • Use Facebooks SDK or Javascript library to authenticate the user on FB.

  • Parse the result for accessToken and use it as in input to this API.


The user’s name, email address and profile picture will be pulled from FB and the user will be created in your DB.

Input:
Element Name Description Type Example
accessTokenaccess Token provided by Facebook APIs when the user has successfully authenticated with Facebook.CHAR(200)
AXIS_APITell the backend the API you want to invokCHAR(50)LoginFacebook

Sample Output:

 
{
    "tokenID": "ABCDCADAD12ADAD",
    "customerID": 1212,
    "returnStatus": "SUCCESS",
    "statusMessage": ""
} 


Get the user’s profile.

Input:

Element Name Description Type Example
tokenIDUser's Token ID.CHAR(60)
customerIDThe Customer's ID.NUM(9)
AXIS_APITell the backend the API you want to invokCHAR(50)UserProfileGet

Sample Output:

 
{
    "firstName": "",
    "lastName": "",
    "imageUrl": "https://axisapi.s3.amazonaws.com/D522B9672870D37BFCAFDE6586.jpg",
    "addressLine1": "",
    "addressLine2": "",
    "city": "",
    "state": "",
    "zip": "",
    "latitude": 0,
    "longitude": 0,
    "emailAddress": "info@axisapi.com",
    "phoneNumber": "2142222222",
    "about": "",
    "returnStatus": "SUCCESS",
    "statusMessage": "",
    "AXIS_API": "UserProfileGet"
} 


Update the user’s profile. All current values in the database will be overwritten with the values passed in this API.

Input:

Element Name Description Type Example
tokenIDUsers Token IDCHAR(60)ADBED1D95D
customerIDThe Customer’s IDNUM(9)1213
firstNameCHAR(60)
lastNameCHAR(60)
addressLine1CHAR(60)
addressLine2CHAR(60)
cityCHAR(30)
stateCHAR(30)
zipCHAR(5)
latitudeDOUBLE
longitudeDOUBLE
aboutCHAR(1000)
AXIS_APITell the backend the API you want to invokeCHAR(50)UserProfileUpdate

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage": "",
    "AXIS_API": "UserProfileUpdate"
} 


Update the user’s profile. All current values in the database will be overwritten with the values passed in this API.

Input:

Element Name Description Type Example
tokenIDUsers Token IDCHAR(60)ADBED1D95D
customerIDThe Customer’s IDNUM(9)1213
phoneNumberThe Phone number. Contiguous numbers. No formatting.CHAR(20)13211231234
AXIS_APITell the backend the API you want to invokeCHAR(50)UpdatePhoneNumber

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage": "",
    "AXIS_API": "UpdatePhoneNumber"
} 


Upload a profile picture for the user. It is best to first resize the photo on the front-end before uploading it to make sure all photo’s are the same size.

Input:

Element Name Description Type Example
tokenIDUsers Token IDCHAR(60)ADBED1D95D
customerIDThe Customer’s IDNUM(9)1213
custPhotoAttachment in POST.
AXIS_APITell the backend the API you want to invokeCHAR(50)UpdatePhoneNumber

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage" : "",
    "imageURL" : "http://somedomain.com/user_photos.jpg"
} 


A pin number will be sent to the use via SMS. For this, the Twilio setup of the instance needs to be completed. To setup Twilio for the instance:

  • Create an account with twilio.com.

  • Login into axisapi.com.

  • Select the Instance.

  • In the instance details, fill the form for Twilio Setup.


Input:

Element Name Description Type Example
emailAddressUser's email address.CHAR(60)joe@aol.com
AXIS_APITell the backend the API you want to invokeCHAR(50)PasswordResetGetPin

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage" : "",
} 


A pin number will be sent to the use via SMS. For this, the Twilio setup of the instance needs to be completed. To setup Twilio for the instance:

  • Create an account with twilio.com.

  • Login into axisapi.com.

  • Select the Instance.

  • In the instance details, fill the form for Twilio Setup.


Input:

Element Name Description Type Example
emailAddressUser's email address.CHAR(60)joe@aol.com
userPinPin.CHAR(10)2325
userPasswordAt lead 8 characters.CHAR(20)nEwPassWORD
AXIS_APITell the backend the API you want to invokeCHAR(50)PasswordResetByPin

Sample Output:

 
{
    "returnStatus": "SUCCESS",
    "statusMessage" : "",
} 


SummaryGet an integer value of a GET or POST variable.
ParameterName of the Variable to set.
Max ValueMaximum Value of the integer. Larger values generate an Error.
Default ValueDefault value incase the variable is not populated.
Status VariableVariable that will be set with a value of FAIL if validations fail.
Message VariableVariable that will be set with the error message if validations fail.

SummaryGet a decimal value of a GET or POST variable.
ParameterName of the Variable to set.
Max ValueMaximum Value of the decimal. Larger values generate an Error.
Default ValueDefault value incase the variable is not populated.
Status VariableVariable that will be set with a value of FAIL if validations fail.
Message VariableVariable that will be set with the error message if validations fail.

SummaryGet a String value of a GET or POST variable.
ParameterName of the Variable to set.
Max ValueMaximum length of the String. Larger strings generate an Error.
Default ValueDefault value incase the variable is not populated.
Status VariableVariable that will be set with a value of FAIL if validations fail.
Message VariableVariable that will be set with the error message if validations fail.

SummaryGet a date value of a GET or POST variable.
ParameterName of the Variable to set.
Date FormatDate format. e.g., dd/MM/yyyy.
Default ValueDefault value incase the variable is not populated. e.g., 01/01/1900.
Status VariableVariable that will be set with a value of FAIL if validations fail.
Message VariableVariable that will be set with the error message if validations fail.

SummaryDeclare an Integer variable
VariableName of a new Variable to declare.
ValueValue of the Variable.

SummaryDeclare an Double Precision variable
VariableName of a new Variable to declare.
ValueValue of the Variable.

SummaryDeclare a String variable
VariableName of a new Variable to declare.
ValueValue of the Variable.

SummaryAssign the value of one variable or structure element to another.
TargetName of a Variable or Structure Element to set.
SourceName of Variable or Structure Element to use.

SummaryDisplay contents of a variable in web server logs for batch processes.
VariableName of the variable or Structure Element to display in the logs.

SummarySet a default value for a variable if it is empty.
VariableName of a Variable to set.
ValueDefault value incase the variable is not populated.

SummaryAdd two variables.
ResultName of the variable or Structure Element to populate with the result.
Param 1Name of the variable or structure element to add.
Param 2Name of the variable or structure element to add.

SummarySubtract two variables.
ResultName of the variable or Structure Element to populate with the result.
Param 1Name of the variable or structure element to subtract from.
Param 2Name of the variable or structure element to subtract.

SummaryDivide two variables.
ResultName of the variable or Structure Element to populate with the result.
Param 1Name of the numerator variable or structure element.
Param 2Name of the denominator variable or structure element.

SummaryMultiply two variables.
ResultName of the variable or Structure Element to populate with the result.
Param 1Name of the variable or structure element to multiply.
Param 2Name of the variable or structure element to multiply.

SummaryGet a random number.
Result Name of the variable or Structure Element to populate with the result.
MinimumName of the variable or structure element containing the minimum value.
MaximumName of the denominator variable or structure element containing the maximum value.

Summary Convert string to upper case.
Result Name of the variable or Structure Element to populate with the result.
Variable Name of the string variable or structure element to convert.

Summary Convert string to lower case.
Result Name of the variable or Structure Element to populate with the result.
Variable Name of the string variable or structure element to convert.

Summary Get the length of a string.
Result Name of the variable or Structure Element to populate with the result.
VariableThe name of the variable or structure element to get the length of.

Summary Trim a String variable.
Result Name of the variable or Structure Element to populate with the result.
VariableName of the string variable or structure element to trim.

Summary Encrypt a string variable.
Result Name of the variable or Structure Element to populate with the result.
Variable The name of the string variable or structure element to encrypt.

Summary Decrypt a string variable.
Result Name of the variable or Structure Element to populate with the result.
Variable The name of the string variable or structure element to encrypt.

Summary a substring in a string with another substring.
Result Name of the variable or Structure Element to populate with the result.
Source The input string to be worked on.
Old String The substring to be replaced.
New String The substring to replace Old String in Source with.

Summary Get a substring of a string variable.
Result Name of the variable or Structure Element to populate with the result.
Source Name of the string variable or structure element containing the field number to cut.
SeparatorName of the string variable or structure element to be used as a field separator.
Field Name of the string variable or structure element containing the field number to cut.

Summary Concatenate strings.
Result Name of the variable or Structure Element to populate with the result.
Variable 1 - 10 Name of the variable or structure element to concatenate.

Summary Evaluate a string variable to repalce variables in it with the value.
Result Name of the variable or Structure Element to populate with the result.
VariableName of the variable or structure element to evaluate.

SummaryDeclare a structure.
Result Name of the Structure to declare.
Format Name of the Format.

Summary Create variables with the same name and values as the elements of the Structure
StructureName of the Structure to explode.

Summary Convert structure into a JSON string.
Result Name of the variable or Structure Element to populate with the result.
Structure Name of the Structure to convert.

Summary Convert a JSON string into a structure.
Result Name of the Structure to populate.
Structure Name of the variable or Structure Element to convert into a structure.

Summary Declare an Array.
Result Name of the Array to declare.
Format Name of the Format the Array will be based on.

Summary Append a structure to an Array.
Result Name of the Array.
StructureName of the Structure to append to the Array.

Summary Get a structure from an array into a Structure Variable.
Result Name of the variable or Structure Element to populate with the result.
Array Name of the Array.
Row Name of the string variable or structure element containing the record number.

Summary Update an Array with a structure.
Result Name of the Array to update.
StructureName of the Structure.
Row Name of the variable containing the record number in the array to update.

SummaryGet the number of records in an Array.
Result Name of the variable to populate with the result
Array Name of the Array

SummaryGet the JSON (String) representation of an Array.
Result Name of the variable or Structure Element to populate with the result
Array Name of the Array.

SummaryConvert an JSON string containing a array into an Array.
Result Name of the Array to populate.
Array Name of the variable or Structure Element to convert into an array.

Summary Run a SELECT SQL and capture it's result.
Result Name of the variable, Structure Element, Structure or Array to populate with the result of the SQL.
SQL Statement The SQL Statement.

Summary Run an update, delete or insert SQL.
Result Name of the variable or Structure Element to populate with the number of rows impacted.
SQL Statement The SQL Statement.

Summary Run an insert SQL statement on an autoincrement table.
Result Name of the variable or Structure Element to populate with the autoincrement value.
SQL Statement The insert SQL Statement.

Summary Run functions based on the evaluation of a condition.
Condition The condition that needs to be evaluated. The condition can have literals and variables.

Numeric variables are represented like <?TotalCount> .
String variables need to be encompassed in single quotes like '<?UserName>'

Example Conditions:

    <TOTAL_COUNT> == 1
    '<USER_NAME>' == 'SMITH'
TRUE Function to be called if the condition evaluates to TRUE.
FALSE Function to be called if the condition evaluates to FALSE.

Summary Run an function for each record in an Array.
Result Name of the variable or Structure Element to populate with the current record being processed.
Array Name of the Array.
FunctionName of the Function that is called for each record in the Array.

Summary Run a Function.
Function Name of the function to run.

Summary Stop further processing and return the result.

Summary Create a unique name for a temporary file.
Result Name of the variable or Structure Element to populate with the new temporary file name.
ExtensionName of the variable containing the extension of the temporary file.

Summary Upload a local file to the web server.
Result Variable or Structure Element that contains the Path and file name to which the uploaded file will be saved.

Summary Delete a file.
Result Variable or Structure Element that contains name of the file to be deleted.

Summary Read the contents of a file into a String. Max size 20 MB.
Result Name of the string variable to populate.
File Name of the variable containing the name of the file to read.

Summary Read the contents of a delimted file into an Array.
Result Name of the Array variable to populate.
File Name of the variable containing the file name.
SeparatorName of the variable containing field separator.
Skip [OPTIONAL] Name of the variable containing the number of records to skip.

Summary Read the contents of a fixed length file into an Array.
Result Name of the Array to populate.
File Name of the variable containing the name of the file to read.
Skip [OPTIONAL] Name of the variable containing the number of records to skip.

Summary Crop an image file to a specific height and width.
Result Variable or Structure Element containing the name of the cropped image.
File Name of the variable or structure element containing the name of the input file name containing the image to crop.
Height Name of the variable or structure element containing the height of the cropped image.
Width Name of the variable or structure element containing the width of the cropped image.

Summary Resize an image file to a specific percentage. Used to create thumbnails.
Result Variable or Structure Element containing the name of the resized image.
File Variable or Structure Element containing the name of the image file to resize.
Percentage Name of the variable or structure element containing the width of the cropped image.

Amazon AWS S3 is a solution provided by Amazon to store files on the cloud.

Summary Upload a file to Amazon AWS S3.
Result Variable Name to save the URL of the document on Amazon S3.
Access Key Variable containing the amazon access key.
Secret Key Variable containing the Amazon S3 Secret Key.
Bucket Name Name of the variable containing the bucket name on Amazon.
File Name Path Name of the variable containing the file path and name.
Output File Name Variable containing the name of the file on Amazon S3.

Summary Get users profile from Facebook.
Email Address Email address of user on Facebook
Access Token Access Token provided by Facebook to client after successful authentication.
First Name Variable containing the users last name on Facebook.
Last Name Variable containing the users full name on Facebook.
Profile Photo Variable containing the users profile photo.

Summary Create a customer in stripe.com (a credit card processing service)
Result Variable that will be created containing the Stripe Customer ID. In case of failure, variable will be empty.
Secret Key Variable containing Stripe Secret API Key for your application.
Token ID Variable containing Payment Token ID returned to the client after successful credit card processing by stripe.
Customer ID Variable containing the Customer ID that will be stored in Stripe.

Summary Make a credit card payment using stripe.com (a credit card processing service)
Result Charge ID of the charge created by Stripe.
Secret Key Variable containing Stripe Secret API Key for your application.
Customer ID "Variable containing Stripe Customer ID. "
Amount Variable containing Total amount to charge in cents. For example, $2 needs to represented as 200.
Currency Variable containing the currency code. For example - usd.
Description Variable containing the description that will appear on the credit card statement.
Transaction ID Variable containing the transaction ID. It can be used to link a payment in Stripe with a transaction in your syste.
App Free [OPTIONAL] Variable containing vendor (destination) the amount (minus the fee) will be transferred to.
Destination [OPTIONAL] Variable containing vendor (destination code) the money will be transferred to.

Summary Make a credit card payment using stripe.com (a credit card processing service)
Result Charge ID of the charge created by Stripe.
Secret Key Variable containing Stripe Secret API Key for your application.
Token ID Variable containing Payment Token ID returned to the client after successful credit card processing by stripe.
Amount Variable containing Total amount to charge in cents. For example, $2 needs to represented as 200.
Currency Variable containing the currency code. For example - usd.
Description Variable containing the description that will appear on the credit card statement.
Transaction ID Variable containing the transaction ID. It can be used to link a payment in Stripe with a transaction in your syste.
App Free [OPTIONAL] Variable containing vendor (destination) the amount (minus the fee) will be transferred to.
Destination [OPTIONAL] Variable containing vendor (destination code) the money will be transferred to.

Summary Make a credit card payment using stripe.com (a credit card processing service)
Result Refund ID of the refund created by Stripe.
Secret Key Variable containing Stripe Secret API Key for your application.
Charge ID Variable containing Stripe Charge ID.
Refund Amount Variable containing Total amount to refund in cents. For example, $2 needs to represented as 200.

Summary Call an API and fetch the result
Result Variable Name to save the result of the API call.
Base URL The end point of the API to call.
Method The method to use to call the API. For example POST, GET, PUT, DELETE etc
Param Variable containing the parameters to pass to the API.

For Example:
name=Joe&age=12
Response Code Name of the variable to store the respose code.

Summary Parse a JSON String to get the value of an attribute.
Result Variable Name to save result of the parse.
JSON Variable Name that contains the input JSON string.
Operation Variable containing the Javascript operation.

When an API is called, it has a few utility variables available to be used.

  • QUERY_STRING - List of parameters passed to the API

  • REMOVE_ADDRESS - IP Address the API was called from

  • JSESSIONID - Current Session ID.

  • UPLOADED_FILE_NAME - Name of the file being uploaded.

For ease of use, there some additional predefined variables available:

SPACEA Single Space
TILDE~
ACUTE`
BANG !
AT @
HASH #
DOLLAR $
PERCENT %
CARET ^
AMPERSAND &
ASTERISK *
HYPHEN -
UNDERSCORE _
PLUS +
EQUALS =
PIPE |
COLON :
SEMI_COLON ;
LESS_THAN <
GREATER_THAN >
COMMA ,
PERIOD or DOT .
QUESTION_MARK ?
QUOTE "
APOSTROPHE
BACK_SLASH \
FORWARD_SLASH /
OPEN_PARENTHESIS (
CLOSE_PARENTHESIS )
OPEN_BRACE {
CLOSE_BRACE }
OPEN_BRACKET [
CLOSE_BRACKET ]
ONE 1
TWO 2
THREE 3
FOUR 4
FIVE 5
SIX 6
SEVEN 7
EIGHT 8
NINE 9
ZERO 0
GET GET
HEAD HEAD
POST POST
PUT PUT
PATCH PATCH
DELETE DELETE
OPTIONSOPTIONS

Adminer is a tool for managing content in MySQL databases (https://www.adminer.org/).

It is a secure, user friendly and light weight database administration tool. It comes pre-installed on your instance.

To login into the Adminer tool, either click on the “Database” button for your instance or click in the “Database” icon in the API Builder Tool menu bar.

This will open the Adminer login page in a separate tab:

logo img

Enter the password to login into Adminer. The password is set and changed using “Password” button for the instance in the Dashboard.

When you login into Adminer, you will see that it is divided into to panes.

The left pane has four buttons and a list of tables with a “select” button next to them. For example:

logo img

Use the top four buttons for this purpose:

Button Name Purpose
SQL CommandQuery your database and analyze data.
ImportImport schema and data from a file on your computer.
ExportExport your database to a file on your computer.
Create TableVisual tool to create new tables.

When one of these button is clicked, the appropriate information will be displayed in the right page.

To work with a table, click on the table name or on the “select” button next to the table name. This will display information about the table in the right page.

On top of the right page, you will see four buttons:

logo img

Button Name Purpose
Select DataQuery your table to visually analyze data.
Show StructureShow the table structure, primary key, indexes etc.
Alter TableModify the table structure, keys, indexes etc.
New ItemA form to insert a new record into the table.





- The End -