Quick Start Guide

Integrating with SMSPortal can begin as soon as you create an SMSPortal account, and requires three steps:

Be sure to refer to our comprehensive API Reference as you navigate through this guide.

📘

Important: API Channel Activation for New Accounts and Sub-Accounts

When you create a new Account or Sub-Account, please be aware that by default, no API channels will be active. To enable API access and manage your Accounts and Sub-Accounts' API credentials and settings, please follow the steps outlined in the "API Keys" page.

Note for Accounts Created Before 6 June 2023: If you have an Account that was created before 6 June 2023, the API channels would have been automatically enabled. However, if you wish to switch to an alternative API or use additional APIs, you will need to create an API Key for the desired API.

Generate your API Credentials

The RESTful API supports two methods of authentication, using your API credentials directly for Basic HTTP Authentication or generating a temporary AEG Token for use on subsequent API requests. All endpoints support API credential authentication as well as Token-Based Authentication.
You can create, view and manage your Client ID and Secret in the SMSPortal Control Panel.

🚧

API Credential Security

Your API Credentials carry many privileges and your Secret cannot be accessed after creation, so be sure to keep them secure! Do not share your secret API credentials in publicly accessible areas such as GitHub, client-side code, and so forth.

To use your API credentials directly, BASE64 encode your API credentials in the format ClientID:APISecret and include them in the Basic Authentication Header. If you wish to use Token Authentication, you will need to generate a 24-hour token by BASE64 encoding your API credentials in the format ClientID:APISecret and include them in the Basic Authentication Header to the /authentication endpoint.

All API requests should be made over HTTPS. Calls made over plain HTTP will work but are not recommended. API requests without authentication will fail.

Start Building

SMSPortal provide step by step recipes to walk you through code samples in different programming languages. You're also welcome to skip ahead and refer directly to SMSPortal's API Reference.

The above recipes contain examples of a basic SMS send. Please view the API Reference for all available features.

Make a Test API Request

To check that your integration is working correctly, send a message with the testMode parameter set to true and ensure that SMSPortal returns a successful response to your API request.

Now you’re ready to go live and start sending!