This article is a guide to FastDraft's API and API FAQ's.

This guide contains the following:

• What is an API?
• How do API's work?
• What is an endpoint?
• What types of actions can be performed via API?
• What type of API architecture does Built Intelligence use?
• What is middleware?
• What is an integration hub?
• What is a connector?
• What types of connectors does Built Intelligence provide for FastDraft?
• What types of external triggers can initiate an action in FastDraft?
• How do I use your API’s?
• How can I access your API’s?
• FAQ’s

What is an API?

API stands for Application Programming Interface.

API is a software intermediary that allows two unrelated applications to talk to each other. It takes data from one programme and delivers it to another. For example, one system can use an API to request data, send updates, or trigger actions in another system without a person doing it manually.

How do APIs work?

APIs typically work through a request-response mechanism:

• Request: A user might initiate an API request by entering a search term or clicking a button. API requests may also be triggered by external events, such as a notification from another application. Each request specifies the data or functionality it needs.
• Response: The API processes the request and sends back the appropriate response, which could be data or a confirmation of an action performed

What is an endpoint?

An API endpoint is a dedicated URL that provides access to a specific resource. For instance, the /CompensationEvent endpoint in FastDraft includes the logic for processing all requests that are related to Compensation Events.

What types of actions can be performed via API?

FastDraft is developed based on the API-first principle. In a nutshell, everything that you can do in the FastDraft user interface can also be done via API. We also have a separate API for reports.

What type of API architecture does Built Intelligence use?

• REST is a common way for systems to share data over the internet. It uses URLs, called endpoints, and uses standard actions such as:
  • GET → get data
  • POST → send data
  • PUT/PATCH → update data
  • DELETE → remove data
  • Usually sends data in JSON
• Webhooks: A webhook is a way for FastDraft to automatically tell another system when something happens. Instead of the other system repeatedly asking FastDraft for updates, FastDraft sends the update to a set webhook URL when a specific event occurs. The receiving system can then use that information to take the next action.

What is middleware?

Middleware is software that sits between systems and helps them understand each other by converting or adjusting data. It can also check, manage, or route requests to make sure everything works smoothly.

What is an integration hub?

An integration hub is a specific type of middleware that acts as a centralised platform for integrating multiple systems. It typically provides a cloud-based user interface for managing integrations and often uses pre-built connectors. Examples include Microsoft PowerAutomate and Zapier.

What is a connector?

Integration hubs use various types of connectors to integrate different applications and automate workflows. The main types are:

• Triggers: Events that start a workflow. For example, when something happens in one app, it can start an action in another app. There are two main types:
  • Polling triggers: These check for new information at regular times.
  • Instant triggers: These start a workflow straight away when something happens.
• Actions: Tasks that happen after a workflow starts, such as creating a record, sending an email, or updating information.

What types of connectors does Built Intelligence provide for FastDraft?

Other applications or integration hubs can make direct calls to all of our API’s. We’re also working on creating pre-built connectors to make integrations even easier. Currently, Built Intelligence provides the following pre-built connectors

• Triggers (events from FastDraft that trigger an action in another application)
  • Communications webhook
  • Documents webhook
  • Users webhook
• Actions (events in FastDraft that can be initiated from a trigger in FastDraft or another application)
  • Create a draft notification
  • Create a draft submission
  • Create a draft instruction

What types of external triggers can initiate an action in FastDraft?

In principle any external event could be used to trigger any action in FastDraft. The key constraint is what trigger events are supported by the other application, how those are made available to FastDraft or to an integration hub. The trigger event needs to include sufficient information to populate the request, or you will need to define rules for populating the missing information.   

What types of activity in FastDraft can trigger an action in another application?

In principle, any event could be used to trigger an action in another application. The key constraint is what actions are supported by the other application either via pre-built connectors or via its API endpoints. The trigger event needs to include sufficient information to populate the request, or you will need to define rules for populating the missing information.

How do I use your API’s?

Our application API is documented here: https://api-docs.builtintelligence.com/

Our reporting API is documented here: https://reporting-api-docs.builtintelligence.com 

How can I access your API’s?

You will need a user account to be set up in FastDraft with the appropriate User Type. Your API access will be the same as your UI access so if you need to see all contracts for your organisation you will need a user type that grants you access to all contracts or you will need to be added as a contract user.

For more on User Types see Understanding Roles and Permissions in FastDraft.

For more on accessing our API’s see FastDraft REST API Quick Start Guide.

FAQ’s

How does API work when SSO is enabled?

If SSO is enabled, the Allow SSO toggle must be turned off, so the user can get an access token without logging in through SSO. We would recommend using a dedicated instance.

Do all users have API access by default?

By default, anyone with an account has API access. However, this is dependent on their User Type within FastDraft.

How do I get my password after I toggle bypass SSO?

You will be sent an email with a new generated password.

What is an Access Token?

An access token is a temporary key that allows you to access an API or system after logging in. It proves that you are authenticated and gives you permission to perform certain actions without having to use your password again.

What is a CSRF Token?

A CSRF token (Cross-Site Request Forgery token) is a security value used to protect websites from unauthorized actions.

How long is an Access Token that has been generated from the Username & Password valid for?

An access token is valid 24 hours

Does the CSRF token, need to be refreshed every call? Or just be a component of every call?

a CSRF token is not typically refreshed on every call.  It just needs to be included with every state‑changing request, to be validated by the server.

Do failed requests count towards my usage limit?

Yes, null calls are included with the total usage

What is the API address for the Application (URL)?

This is the URL you use to access API. For example, your API address will just be your standard URL domain with API added to the end. E.g. demofastdraftapi.com