Quick Start

Authentication

A client token provided by MyFileRunner is necessary in order to interact with the MyFileRunner API. It should be included in the headers of all your requests with the name client-token and the value containing the token itself.

You can request your client token from a MyFileRunner administrator. Here are the steps to obtain your client token and start interacting with our API directly:

• In Postman

  • If you have not created a collection or environment, create one.
  • In the collection or environment view, select the Authorization tab.
  • In the Type dropdown menu, select the option API Key.
  • Name the Key client-token, paste the MyFileRunner token in the Value field, and make sure that the Add to dropdown menu is set to Header.

• In JavaScript

  Include the key client-token in the headers with its value set to the token you have obtained from MyFileRunner, as shown.

                  
      fetch("https://app.myfilerunner.com/api/v1/healthCheck", {
          "method": "GET",
          "mode": "cors",
          "headers": {
              "client-token": "api-mfr-0123456789abcdef0123456789ABCDEF",
              "content-type": "Application/JSON",
          },
          "body":  {
              // This server request does not require body parameters.
          }
      }).then((response) => { response.JSON() })
      .then((data) => {
          //...
      });
  
  
              

Note: most functions require a session token called user-token which is obtained on login. This user token is associated to your client's session (i.e., your web browser, Postman, or your application communicating with the API).

The Service module functions do not require a user-token, but the client-token is still required for all functions.

Troubleshooting

Before contacting support, make sure the following requirements are met:

• Your development environment is set up correctly.
• You have a valid client token and it is included in the header of every request.
• Your endpoints are spelled correctly and pointing at the right module routes.
• Your endpoints are listed with the correct HTTP methods.

If you have further questions, write to the provided contact email address for support.