Using the Fabius API

Fabius API Documentation

Introduction

This documentation provides all the necessary information for using the Fabius API. It includes steps to obtain an API key, authentication methods, request semantics, and the response schema.

Obtaining an API Key

Steps to Get an API Key:

  1. Login to Fabius: Access Fabius and log in with your credentials.
  2. Navigate to API Keys:
  3. Go to Settings.
  4. Click on Company Settings.
  5. Select API Keys.
  6. Create a New Key:
  7. Enter a name for your new API key.
  8. Click Add.
  9. Save Your Key: You will receive a Client ID and a Client Secret.

Important: Save your Client Secret immediately, as it cannot be retrieved again once you close the modal.

API Semantics

Base URL

https://api.fabius.io/external/v1

Available Routes

  • Product Gaps Route: /productGaps

Authentication

  • Use Basic Auth with your Client ID and Client Secret.
  • Client ID is your username.
  • Client Secret is your password.

Query Parameters

since (optional): An Epoch Unix timestamp.

  • When included, returns records created after this time.
  • A future timestamp will be rejected.

Note: Including any parameters other than since will result in a 404 error.

Response Schema

The response is structured as an array of objects. Here is the JSON schema:

Conclusion

For further assistance or queries, please contact support@fabius.io.

Still have a question? Contact us
24×7 help from our support staff