CCI FasCard API Overview

API Data Retrieval

WebAPI is open-ended and supports a variety of mechanisms for connecting and retrieving data.  The mobile website/app operates through API data calls.  Several other API calls have been implemented to provide a variety of data directly.  We use a freely available program called Postman (https://www.getpostman.com) but any tool can be used to interact with API.

Note: Our WebAPI servers only support connections using TLS v1.2 or later.  Earlier versions of TLS and SSL are no longer considered secure.

Getting Connected

Obtain Token

POST https://m.fascard.com/api/AuthToken

Pass username and password as body to API GET call:

{
	"UserName": "myFasCardlogin@email.com",
	"Password": "myPassword"
}

The response will be a unique token identifier for your user/password login:

{
	"Token": "abcdefghijklmnopqrstuvwxyz"
}

Postman Authentication

1. Create a new collection
2. Right-click on the collection folder name and select Edit.
3. Click the Authorization tab and select the TYPE as ‘Bearer Token’.
4. Paste in the Token field.
5. Press <Update> button

Available API Calls

Account

GET https://m.fascard.com/api/Account

Account Info for current user

GET https://m.fascard.com/api/Account?MobileApp=xyz

Account Info for current user limited to specific Mobile App

Add-Value Package

GET  https://m.fascard.com/api/AddValuePackage

Retrieve all Add-Value packages available to current user

Cards

GET https://m.fascard.com/api/Card

Cards owned for current user

Coupons

GET https://m.fascard.com/api/Coupon

Coupons applied to current user

Equipment

GET https://m.fascard.com/api/Equip

Equipment available to current user

GET  https://m.fascard.com/api/Equip?LocationID={locID}

Equipment by Location

Feedback

POST  https://m.fascard.com/api/Equip

Submit an issue or feedback.  App type directed to LaundryCard support account, all other issue types directed to employees with "IssueNotify" role and if none then to all customer admins.

Equipment Pricing&Features Schedules

GET  https://m.fascard.com/api/Equip/{equipID}/Schedule/{locID}

Retrieve pricing and feature schedule information about a particular equipment at a location

Requirements: Account Admin or 'Equipment Setup' privilege

Location

GET  https://m.fascard.com/api/Location

Locations available to current user

GET  https://m.fascard.com/api/Location/{locID}

Location by ID

Location Logo

GET  https://m.fascard.com/api/Location/{locID}/LogoImage

This returns the raw binary data of the location's logo image or falls back to Account's logo image.  It is represented as base64 data and can be displayed through html: <img src="data:image;base64,{{response}}" />

Machine

GET  https://m.fascard.com/api/Machine

Machines active for current user

GET  https://m.fascard.com/api/Machine?MachineID={machID}

Alternative:  GET https://m.fascard.com/api/Machine/{machID}

Machine by ID

GET  https://m.fascard.com/api/Machine?LocationID={locID}

Machines at location

Machine Edit

POST  https://m.fascard.com/api/Machine/{machID}

Request to edit values for a specific machine.

Raw Body must be provided with request details consisting of one or more of the following editable fields.  Response will be returned as Machine GET.

See example requests below:

{
	"Label": "Washer1",
	"LastServiceDate": "2020-10-31T00:00:00"
}

Machine History

GET  https://m.fascard.com/api/Machine/{machID}/History

Retrieve machine status history for a particular machine. Similar to admin site, only changes in status or error codes will be listed.  Default 60 change records.

Alternative:  GET  https://m.fascard.com/api/Machine/{machID}/History?Limit={rec limit}
Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000. 

Satellite

GET https://m.fascard.com/api/Satellite

Satellites accessible for current user

GET https://m.fascard.com/api/Satellite/{satID}

Satellite by ID

GET https://m.fascard.com/api/Satellite?LocationID={locID}

Satellites at location

Satellite History

GET  https://m.fascard.com/api/Satellite/{satID}/History

Retrieve satellite status history for a particular satellite. Similar to admin site, only changes in status or uplinks will be listed.  Default 20 change records.

Alternative:  GET  https://m.fascard.com/api/Satellite/{satID}/History?Limit={rec limit}
Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000. 

System Statistics

GET  https://m.fascard.com/api/SysStats?Types={comma list}&MinDateTime={start}&MaxDateTime={end}&Interval{seconds}

Alternative to retrieve latest record:  GET  https://m.fascard.com/api/SysStats?Types={comma list}

Retrieve system statistics of specified type(s).  Types are specified in comma delimited list.  When requesting multiple types, the records will be returned in type groups.

Do not include MinDateTime and MaxDateTime in order to get latest record.  Otherwise set MinDateTime and MaxDateTime to the desired range.  If desiring oldest records up to certain point, leave out MinDateTime and only set MaxDateTime.  Alternatively if desiring newest records from a certain point, leave out MaxDateTime and only set MinDateTime.

Interval is defined in number of seconds.  Do not include to leave returned data as original recorded period.  If specifying custom interval, the return data will be aggregated to best meet the requested interval.  For example with data collected every 10 seconds and a requested interval of 60 seconds, then each returned data structure will be comprised of combining 6 data points.  If requesting too small of an interval then the data will be returned as original with actual duration.

Transactions

GET https://m.fascard.com/api/Transact?AccountID={AccountID}&UserAccountID={UserAccount ID or 0 for all}&Limit={rec limit}&lastID={previous ID}&Older={true/false}

Retrieve all or specific user account associated with specified AccountID.  Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000.  Use 'LastID' parameter to resume from previous ID.  Use 'Older' parameter set to True for retrieving records prior to 'LastID' and set to False for records following 'LastID'. Records will always be returned in descending order.

Requirements:  Account Admin or 'Reports' privilege

User

GET  https://m.fascard.com/api/User

User Info for current user

POST https://m.fascard.com/api/User/{userID}?AccountID={accountID}

Edit details of existing user.  The UserID is obtained from UserAccount or Account.

Requirements:  Account Admin or 'User Manager' privilege

DELETE  https://m.fascard.com/api/User

Remove all personal details and login credentials for current user

User Notifications

GET  https://m.fascard.com/api/User/Notify?Token={pushToken}&Type={pushTokenType}

Request all push notification configurations for current user by specified token and token type (see below table specification for value enumerations).  Type is always required but if Token is not specified then all push notification configurations will be returned for user which could span multiple tokens.

POST  https://m.fascard.com/api/User/Notify

Request to set specific push notification configuration for current user.

User Account

GET  https://m.fascard.com/api/UserAccount/{accountID}/{userAccountID}

Retrieve specific user account associated with specified AccountID

Requirements:  Account Admin or 'Loyalty Accounts' privilege

GET  https://m.fascard.com/api/UserAccount/{accountID}?limit={rec limit}&lastID={previous ID}&prev={true/false}

Retrieve list of user accounts associated with specified AccountID.  Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000.  Use 'LastID' parameter to resume from previous ID.  Use 'Prev' parameter set to True for descending order and set to False for ascending order

Requirements:  Account Admin or 'Loyalty Accounts' privilege

GET  https://m.fascard.com/api/UserAccount/{accountID}?limit={rec limit}&lastID={previous ID}&prev={true/false}&hasEmail={true/false}&lastActivity={datetime}

Retrieve list of user accounts associated with specified AccountID.  Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000.  Use 'LastID' parameter to resume from previous ID.  Use 'Prev' parameter set to True for retrieving records prior to 'LastID' and set to False for records following 'LastID'.  Records will always be returned in descending order.

Note the addition of optional parameters 'hasEmail' and 'lastActivity'.  Either one, both, or neither can be included for additional filtering capabilities.

Use 'hasEmail' parameter set to True for retrieving only UserAccounts with a set email address and set to False for retrieving only UserAccounts without a set email address.  Leave 'hasEmail' parameter out to not filter by email and return all UserAccounts based on other parameters.

Use 'lastActivity' parameter for gathering UserAccounts with an activity at or newer than the specified datetime.  Leave 'lastActivity' parameter out to not filter by last activity datetime and return all UserAccounts based on other parameters.  The datetime is specified in ISO 8601 format
(e.g. YYYY-MM-DDThh:mm:ss for UTC or YYYY-MM-DDThh:mm:ss+/-hh:mm for specifying a local time offset)

Requirements:  Account Admin or 'Loyalty Accounts' privilege

GET  https://m.fascard.com/api/UserAccount/{accountID}?cardNo={card number}

Retrieve specific user account associated with specified AccountID and card number.

Requirements:  Account Admin or 'Loyalty Accounts' privilege

User Account Value Request

POST  https://m.fascard.com/api/UserAccount/{accountID}/{userAccountID}

Request to add values to a specific user account associated with specified AccountID

Requirements:  Account Admin or 'Loyalty Accounts' privilege

Raw Body must be provided with request details.  Response will be returned as User Account GET.

See example requests below:

{
	"TransType": 3,
	"TransSubType": 0,
	"LoyaltyPoints": 100,
	"FreeStarts": 2,
	"AdditionalInfo": "This is an admin adjustment via API"
}

{
	"TransType": 3,
	"TransSubType": 3,
	"Balance": 20,
	"AdditionalInfo": "This is a refund adjustment via API"
}

{
	"TransType": 2,
	"TransSubType": 2,
	"Cash": 10,
	"LocationID": 2
	"AdditionalInfo": "This is a CashToEmployee add via API"
}