Skip to content

Welcome to API Documentation

Engineerforce API is a powerful backend, which follows REST API methods and providing services for frontend frameworks like ReactJS or Vue.

Just mentioning, here is our official website.

Some reasons you might want to use our REST API:

  • Because you can integrate with your frontend framework of choices.

API Overview

Our API is available for everyone to use. An EF user account is required to request an API key. With this API key, the developer can access the API and use it to build their own applications. The API is easy to use and can be integrated into any application that needs access to EngineerForce Data. This documentation provides all the necessary information to get started consuming the API. For the future updates, we will try our best to post these relevant updates to the official documentation.

Getting Started

As mentioned above, you need to have an EF account to request an API key. You can request an API key by generating an API token from in API Settings page. You can also view the screenshots below for help:

  1. Click the "API Settings" link in the left sidebar (View).
  2. Enter API Token Name and Description. Then, click "Generate" Button (View).
  3. Copy the generated API Token and save it somewhere safe (View).

Once you have an API key, you can make requests to the API by sending an HTTP GET request to the following URL:

GET 
curl --location --request GET 'https://app.engineerforce.io/api/v2/' \
--header 'Authorization: API-Token {{YOUR_API_TOKEN}}'

Replace {{YOUR_API_TOKEN}} with your API key and now you can make requests to our API.