Direct API

Direct API calls must originate from your server

A token from /direct/login is required for all other Direct API end-points. It is a bearer authorization token.

Once you have a preauth token, returned from /direct/user-reg or /direct/preauth-token, pass it to the Web UI entry point in the embedded iFrame.

Be sure to save the ID returned from /direct/user-reg or you won’t be able to reauthorize the user when they return.

**The preauth token is only valid for 30 seconds

Endpoints

Collection of end-points that should be called from your server.

CUSTOMER LOGIN (POST)

/direct/login

Using your credentials in the request body ("apikey" and "secret"), the response will contain the token and refresh token.
These tokens are required for completing the other requests to Direct API endpoints.


This token will be valid for approximately one hour. After the one hour, the refresh token will become valid.


If the token expires, use /direct/refresh-token?token={refresh} to get a new token





CUSTOMER REFRESH TOKEN (GET)

/direct/refresh-token

Token and refresh tokes are required for completing the other requests to Direct API endpoints.

The token will be valid for approximately one hour. After the one hour, the refresh token will become valid.

When the token expires, use /direct/refresh-token?token={refresh} to get a new token




REGISTER NEW USER (POST)

/direct/user-reg

Creates a new user with unique userId and preauth token.


When a user logs back in, use /direct/preauth-token/{userId} to generate that user a new preauth token and a new userId (refer to Returning User)

Don't store the token across sessions. Use the userId from the previous session to generate a new userId and a new preauth token.




NEW USER TOKEN (GET)

/direct/preauth-token/{userId}




CLOSE USER ACCOUNT (POST)

/direct/close-account/{userId}




CHANGE USER EMAIL (POST)

/direct/change-email/{userId}




CHANGE USER PHONE (POST)

/direct/change-mobile/{userId}




CHANGE USER HOST (POST)

/direct/change-host/{userId}




UPDATE USER REFRESH DATA (POST)

/direct/update-refresh/{userId}

*Premium Feature - May Require Additional Access




GET ALERT DETAIL (GET)

/direct/efx-alert/{alertId}

*Premium Feature - May Require Additional Access