Integrating with SMSPortal can begin as soon as you create an SMSPortal account, and requires three steps:
- Generate your API key so SMSPortal can authenticate your integration’s API requests.
- Start building so that your integration can interact with the REST API
- Make a test API Request in test mode to confirm that everything is working.
Be sure to refer to our comprehensive API Reference as you navigate through this guide.
The REST API uses an API Client ID and API Secret to authenticate requests. You can create, view and manage your Client ID and Secret in the SMSPortal Control Panel.
API Key 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.
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.
The RESTful API authenticates HTTP requests using tokens, which are generated using your API credentials. Each token is valid for 24 hours from creation, after which they expire and a new token will need to be generated.
To generate a token,
BASE64 encode your API credentials in the format
ClientID:APISecret and include them in the Basic Authentication Header.
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.
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!
Updated 8 months ago