Developers

Authentication API

HOW TO AUTHENTICATE WITH MSGME

In order to use the Msgme APIs, authentication with the API service is required. An API key is initially sent to you by a Msgme account manager. These 128-bit encrypted API keys are SHA1 based hashes of certain parts of your developer account details and a randomly generated variable. API keys can be revoked anytime and reassigned at the client's request by Msgme's client service managers.

A developer must authenticate with Msgme's API service using the appropriate API key which is allowed access to the account(s) that he/she needs to access. After the authentication process, the method system responds with an access token. Use this token value for all subsequent API requests to Msgme. The tokens have a limited lifetime period of 24 hours. When the token expires, an apiError response is generated, at which point a new authentication request must be made to receive a new token.


API KEY-BASED ACCESS CONTROL

A Msgme developer API key is associated on a per account(s) basis. In order to obtain an API key, first sign up to request a Msgme developer account. During the initial signup process, a Msgme client services representative will verify the developer account and any Msgme accounts you wish to access with the API key. After finishing the process the API key can be used to interact with Msgme's API service and access associated Msgme accounts.

NOTE: If a new Msgme account is created that requires developer access via API, simply contact an Msgme representative to associate your API key with the newly created Msgme account.

Developers may be issued multiple API keys, each having different Msgme account access permissions.


METHODS

authenticate_api

Allows retrieval of a temporary token that is used for subsequent API requests to Msgme's API services.

get_account_ids

Allows retrieval of the Msgme account IDs that are associated with your API token.