COMAPI

Quick Start

Get Started with Comapi quickly and easily

Follow this short guide to get signed up to Comapi and start sending with or APIs:

Get signed up

Sign up online now and try our services and SaaS tools for free for a limited time at the Comapi Portal.

You need an account to continue!

Sign-up now for Comapi as you will need an account to continue with this guide

Login in to the Comapi Portal with your login credentials you created in the previous step.

Comapi Portal login

Comapi Portal login

What is an API Space?

API Spaces are logical partitions used to own data and settings in Comapi.

As a new user you will be presented with a pop-up upon login prompting you to add your name, we will automatically create you a new API Space. Go ahead and enter your name now.

Enter your name to complete registration

Enter your name to complete registration

Configuring your API Space

You can select which API Space you want to work with by selecting it from the API Space drop down at the top of the page (Highlighted in yellow below). Select your newly created API Space now.

Next open the Hub section on the left of the page (Highlighted in green below) and select API Space Details

I can't see the left menu?

To save space Comapi automatically hides the left hand menu if you are not using a widescreen resolution. Simply click on the 3 horizontal lines in the top left to open the menu.

API Spaces are identified using a GUID which we refer to as the API Space Id. All the Comapi APIs will require the API Space Id in order to be called, so they can identify what data to access. You can find you API Space's id in the API Space Details screen (highlighted in green below), with a convenient copy button:

Copying your API Space Id

Copying your API Space Id

Create an Access Token for the API to use

Click on the Access Tokens option in the Hub section of the left hand menu.
Click the Add new access token button, and follow the wizard that pops up. Fill in the Name and Profile Id fields. The Name field describes the access token or its intended purpose such as the system that will use it. The ProfileId field is for setting the identity for the token i.e. the Comapi profile this token represents. This is particularly useful for App Messaging where you want to message users as a virtual system user.

Now click Next to select your access tokens permissions. There are a many different sets of permissions to choose from, but for our purposes simply select all the One API Access - All Channels + Branch, as we want our system to send messages on any channel. For more info on permissions see here

Creating an access token

Creating an access token

Selecting the permissions for your access token

Selecting the permissions for your access token

Now click the Create button to create the access token.

Your access token will be shown with a convenient copy button on the right hand side. Ensure you copy this now and store it somewhere safe as it cannot be retrieved once you have navigated away from this page for security reasons.

Ensure you copy your access token

Ensure you copy your access token

Ensure to store your access token securely

Your access tokens must be copied and stored securely when they are displayed as they cannot be retrieved again after this time, only revoked.

Send a SMS

Ok now we have an access token we can send a message using the "One" API.

Below is some JavaScript based on JQuery to call the Comapi "One" API to send an SMS.

To try it click on the below to enter your API Space Id, access token and mobile number to try the service.

Don't embed your access tokens client side

This is just an example to show you how easy it is to call the Comapi "One" API, do not embed access tokens into client side code as it is insecure!

And now...

Now you've seen how easy it is to get started with the "One" API why don't you see what you can do with it and incorporate other channels such as Facebook.

Find out more in Channel Setup