# Getting started
β¨ WHATSAPP API IS HERE!
Now you can use our API to launch widely distributed campaigns through the whatsapp platform Yes, it's as genius as it sounds.
Mandatory Configuration
You must ensure the use of HTTP security level (TLS - Transport Layer Security) of 1.2 or higher.
You must use our secure IP restriction service.
To enable the service, navigate through the app to "My Account" under the "Settings" tab, and activate the option "Enable Authorized IP Address Check".
After enabling the service, make sure that at least one authorized IP address is configured.
# π API Token Guide
Before starting to use our API, you will need your account Username, as received in your mailbox during registration.
In order to start using our API services, you need to generate an API TOKEN.
# πβ οΈ Important Security Notice
π¨ Security Update: Creating tokens using a username and password is no longer supported.
Tokens can now only be created using one of the following methods:
- β Through the web interface
- β Via an API call using an existing token along with the username
You can create multiple tokens for the same user, and all tokens will operate concurrently without invalidating each other.
To support this, each token must be assigned a unique name.
When a token is created via the API, its name is automatically set based on the date and time of creation.
Note: A maximum of 5 active tokens is allowed per user.
# π§· Creating Your First API Token
To start using the API, you must first create your initial token through the interface:
- Go to the "Settings / ΧΧΧΧ¨ΧΧͺ" tab and select βAPI Token Management / Token API Χ ΧΧΧΧβ.
- Click βCreate New Token / ΧΧ¦ΧΧ¨Χͺ ΧΧΧ§Χ ΧΧΧ©β.
- After the token is generated, it will be displayed to you only once. Please save it securely for future use - it will not be possible to retrieve it later.
# π Creating Additional Tokens via API
Once you have at least one valid token:
- Additional tokens can be generated through API calls using the username and an existing valid token included in the request.
- Any valid token can be used to send any request via the API.
Follow the instructions carefully and make sure to include the token in the appropriate part of the request.
Below is an explanation of how to create a new token using an existing one via API.
Note: The expiration period of each token is fixed and does not get extended or renewed when creating new tokens via the API.
# π οΈ Token Management via Web Interface
Token management is performed through the web interface.
Within this interface, you can view all tokens you have created β including those generated via the API.
You may also delete an existing token, and once deleted, the token is immediately deactivated and can no longer be used.
# Generate API TOKEN
# Description
You can use this API to generate an api token.
# Endpoint
POST https://my.textme.co.il/api
# Header
Name | Type | Description |
---|---|---|
Content-Type | application/xml | In case of sending XML its required header |
Content-Type | application/json | In case of sending JSON its required header |
Authorization | Bearer YOUR TOKEN | Valid token |
# Parameters
Name | Type | Description | Required |
---|---|---|---|
user->username | string | Admin account username | βοΈ |
username | string | requested account username | βοΈ |
action | string | "new" / "current" | βοΈ |
# "current" action
This action is used to retrieve the most recent token. Note: A valid token must be included in the request.
# Request Example
# Response Example