keyGet an API Key

Learn how to generate API keys to create authenticated requests to the Mobile Text Alerts API.

circle-info

In order to receive an API Key, you must have a Mobile Text Alerts account. Click herearrow-up-right to sign up for one!

Generate an API Key

API Keys can be generated in the Mobile Text Alerts platform dashboard.

  1. Visit Settingsarrow-up-right for your account. This is under the three-dot menu in the top right of the platform dashboard.

  2. Select the Developerarrow-up-right tab or scroll down to Developer Resources.

  3. Click the GENERATE A NEW KEY button. Enter a name for the new API Key.

circle-exclamation

This API Key is used to make authenticated calls to the Mobile Text Alerts API.

Bearer Token Authentication

This API Key is used as a bearer token when making requests to the API. A bearer token is included in the request header to grant a user or application access to a protected endpoint.

Header structure: "Authorization: Bearer {myAPIKey}"

Example request to verify the API Key

The examples below send a request with a bearer token to the /verify-api-key endpoint. This verifies the API Key is valid:

curl -L \
  -H 'Authorization: Bearer 89fa747a-e01b-5940-99c2-4e96fa996258' \
  'https://api.mobile-text-alerts.com/v3/auth/verify-api-key'

If the key is valid, the API returns the message: "API Key verified"

A 200 indicates success. See Error Response Codes for possible error codes.

Verify API Key

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Success

application/json
get
/auth/verify-api-key

With a verified API key, you’re ready to send real messages. See Send a Message to learn more.

Last updated

Was this helpful?