To access information from FranchiseBlast via API, you are given an API user account which has access to our full API testing tools and documentation found here:


https://admin.franchiseblast.com/apiv1explorer/apitests


The documentation is baked into the API test tools, ensuring you have the freshest version. This document outlines how to utilize these test tools.


Step 1) Authentication

The first step is to login to the system via the login tab.




Step 2) Explore the API calls

For example, this lets you return all audits between January 1st, 2019 to November 1st, 2019 for a specific auditor ID. Click Test to get started. 






Step 3) Browse the results

Clicking on Test opens a dialog with your API results in JSON format.




Step 4) Details

In the background, the tool first makes an HTTP GET to:


https://admin.franchiseblast.com/api/v1/Login?username={username}&password={password}


with the credentials of the account given to you. This query returns the Authorization-Token you will use within subsequent requests.


https://admin.franchiseblast.com/api/v1/Audits?search={search}&franchiseGuid={franchiseGuid}&sto reGroupGuid={storeGroupGuid}&storeId={storeId}&from={from}&to={to}&status={status}&auditor={au ditor}&questionnaireGuid={questionnaireGuid}&offset={offset}&limit={limit}


This request includes the authentication token from the login request in the HTTP headers under the HTTP header name Authorization-Token.


It is also including the Accept HTTP header specifying which specifies the format of the response: Accept header value:

•    JSON (default): application/json;charset=utf-8

•    XML:    application/xml;charset=utf-8

•    Atom: application/atom+xml;charset=utf-8

If you are logged in to the account already, you can open up the page directly in your browser (without having to specify an authorization token) and see results in XML:


https://admin.franchiseblast.com/api/v1/Audits


The formatting of the response varies based on the Accept HTTP parameter, as per the documentation in the API testing tool


Feel free to contact support@franchiseblast.com with any questions about the API.