Commander License

Sign Up for your API Key

API Documentation Pages

These are the documentation pages for the Commander License API, used to placed orders, manage customer profiles and more. Be sure to read the additional documentation pages in the links above, and contact us for your very own API Key.

List of APIs

Advertising

Impression

Auth API Description
POST Advertising/Impression

Adds the advertising impression aync.

POST Advertising/Impressions

Adds the advertisings impression aync.

GET Advertising/Impression/FromEmail
?data={data}&clicked={clicked}

Adds the advertising impression from email aync.

GET Advertising/Impression/EmailClick
?data={data}

Adds the advertising impression via email click.

GET Advertising/Impression/Tracking
?data={data}

Advertisings the impression tracking.

Channel

Channel

Auth API Description
GET Channel/List

Gets all channels asynchronous.

GET Channel/RegisteredList

Gets the registered channels asynchronous.

POST Channel/Register

Registers the specified channel.

DELETE Channel/Remove
?channelId={channelId}

Removes the channel asynchronous.

POST Channel/UpdateRegistrationStatus

Updates the registration status asynchronous.

POST Channel/Settings

Updates the channel settings asynchronous.

GET Channel/Settings

Gets the channel settings asynchronous.

POST Channel/RemoveUsersFromChannel

Removes the users from channel asynchronous.

WebsiteUser

WebsiteUser

Auth API Description
GET WebsiteUser/Exists
?emailAddress={emailAddress}

Checks if website user exists asynchronous.

POST WebsiteUser/HasPassword

Checks if website users has passwords asynchronous.

POST WebsiteUser/UpdatePushNotificationToken

Updates the push notification token asynchronous.

GET WebsiteUser/Profile

Gets the website user profile for phone application.

PUT WebsiteUser/Profile

Updates the website user profile via phone application asynchronous.

POST WebsiteUser/Merge

Merges the website user asynchronous.

PUT WebsiteUser/EmailAddress

Updates the website user email address asynchronous.

POST WebsiteUser/Delete

Deletes the website user from channel asynchronous.

POST WebsiteUser/PhoneNumber/Modify

Adds the website user phone number asynchronous.

POST WebsiteUser/PhoneNumber/Delete

Deletes the website user phone number asynchronous.

Communication

Communication

Auth API Description
POST Communication/SendGrid/AlumNet/Parse

Sends the grid alum net inbound parse.

POST Communication/PushNotification

Sends the push notification asynchronous.

Media

Media

Auth API Description
GET Media/AppLogo
?id={id}

Applications the logo.

Report

Report

Auth API Description
GET Report/IsReportUpToDate
?productIdentification={productIdentification}&lastReportUpdatedAt={lastReportUpdatedAt}

Determines whether [is report up to date] [the specified product identification].

POST Report/GetReportUpdates

Gets the report updates.

Security

Session

Auth API Description
POST Authentication

Creates a new session for the user identified by the credentials provided by the basic authentication header and returns a session token for subsequent calls.

DELETE Authentication

Ends the session identified by the 'Authorization Session' header.

POST Authentication/GetSession

Determines whether [is session valid] [the specified session token].

Authentication

Auth API Description
POST Authentication/BulkChangePassword

Bulks the change website user password asynchronous.

POST Authentication/ChangePassword

Changes the website user password asynchronous.

POST Authentication/ChangePasswordViaBot

Changes the website user password via alumnet bot asynchronous.

POST Authentication/ValidatePasswordResetToken

Validates the password reset token asynchronous.

POST Authentication/ForgotPasswordToken

Forgots the password token.

POST Authentication/ForgotPassword
?sendPasswordResetEmail={sendPasswordResetEmail}

Forgots the password.

POST Authentication/RegisterAccountsThatDoesNotExistAndReturnPasswordResetTokens

Forgots the password tokens.

POST Authentication/ResetPassword

Resets the website user password.

Register

Registration

Auth API Description
POST Register

Registers the website user asynchronous.

POST Register/SendRegistrationEmail

Sends the registration email asynchronous.

POST Register/FromChannel

Registers the website user from channel asynchronous.