FRAGTrack™ External API

This guide is intended for developers integrating BlastIQ™ data into their own applications and other users wanting to directly access their BlastIQ™ data using the BlastIQ™ External API.

Introduction

The FRAGTrack™ External API provides sample information in batches of up to 200, ordered by the most recent update timestamp. Authorised users and authenticated systems are allowed to query from a requested date, limited to a single site. Consumers of this API can use this to maintain a synchronised set of samples for any period of time. Information contained within each sample includes:

  • Geographic Position
  • Device and Installation Information
  • Segmentation (bin sizes)
  • 80% passing size

Providing feedback

We welcome feedback on the FRAGTrack™ APIs and suggestions for improvement, you can make suggestions here at our BlastIQ™ Product Feedback.

Getting Help

If you have questions or would like assistance with integration to FRAGTrack, please raise a support ticket with BlastIQ Support and we would be happy to assist you

 

Attended API Integration

A user with access permissions to access a site's data using the FRAGTrack applications can also access the data using the API. This is useful for interactive applications where a user can be asked to authenticate themselves.

A developer building an application with attended integration should contact BlastIQ Support for assistance by raising a ticket below.

You must use an attended integration flow where an individual user is interacting with BlastIQ. Never distribute and use Service User credentials in desktop or other applications where an individual user is interacting with FRAGTrack.

Unattended API Integration

Unattended integration is to be used for Server <-> FRAGTrack communication where an individual user is not interacting with FRAGTrack.


The FRAGTrack External API can be configured to use a set of Service User credentials that are authorised to access data for a single BlastIQ site. You must request credentials for a Service User (username & password). Please raise a support ticket below to discuss your needs.


The Service User credentials can then be used for accessing data via the FRAGTrack External API.
Service User accounts will only have access to a single Site's data, software vendors building integrations for customers must allow the customer to enter valid credentials for their site.

Always handle and store your Service User credentials securely!

Authentication type
oidc

Authority
https://www.blastiq.com/identity

Discovery document
https://www.blastiq.com/identity/.well-known/openid-configuration

Client Id
Please request a Client ID by raising a support ticket.

Token Management
In order to retrieve a token using Service User credentials, refer to the documentation available from Auth0 https://auth0.com/docs/api-auth/tutorials/password-grant#ask-for-a-token

Depending on the language you are using, you may find a library to make the process easier.

Example c# code using IdentityModel.OidcClient2

var disco = await DiscoveryClient.GetAsync("https://www.blastiq.com/identity");
if (disco.IsError)
{
Console.WriteLine(disco.Error);
return;
}
var tokenClient = new TokenClient(disco.TokenEndpoint, "Insert your Client ID provided by BlastIQ Support");

var tokenResponse = await tokenClient.RequestResourceOwnerPasswordAsync(username, password, scope: null);

if (tokenResponse.IsError)
{
Console.WriteLine(tokenResponse.Error);
return;
}
var accessToken = tokenResponse.AccessToken;
var refreshToken = tokenResponse.RefreshToken;

 

Example Python

https://docs.authlib.org/en/latest/client/oauth2.html#oauth2session-for-password

 

Testing and interacting with the FRAGTrack External API

A Swagger page is available to test the FRAGTrack External API at: https://www.blastiq.com/fragtrack/api/swagger/index


The Swagger page provides details on data types, response codes and other information for developers.
When using Swagger, a blastiq.com login can be used for authentication.

FRAGTrack External API

Available API Methods

Use the Interactive Swagger page at https://www.blastiq.com/fragtrack/api/swagger/index to view available methods, parameters and example responses. The Schemas section at the bottom of the page provides a purpose, example and data type for every field.

API Version Status

Version 1: Production Q3 2020

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request