RFA interactive API library

The API library documents all of the APIs Remote File Access provides.

The library runs as an interactive client served to your browser by an RFA listener. This enables you to test actual requests and responses against your configuration.

To access the interactive API library, append /mfrfa/docs to your base RFA URI in your browser address bar, for example http://localhost:9999/mfrfa/docs.

To start using the interactive API:

  1. Click Server to open the Server category. The /logon and /logoff APIs should be listed.
  2. Click /mfrfa/logon to open the Logon dialog.
  3. Click Try it out to open the area where you can edit the request body.
  4. Replace the two "string" string values in the sample request body with your username and password. For example:
    {
       "mfUser": "SYSAD",
       "mfPassword": "abcd1234"
    }
  5. Click Execute.
  6. If the request was successful, you will receive a server response with an HTTP status code of 200 and an empty JSON response body ({}).

Once you have a cookie for a valid session you can perform other RFA requests, such as getting and putting files.

Note: Your session will eventually time out. You can clear it manually using the /logoff API.

The interactive API library manages the Host, Origin, Referer, Accept, Content-Type, and Content-Length headers for you. It also stores and applies the cookie for session handling.

Note: The interactive API library and any other RFA use in the browser share a session. Logging in or out from one will affect the other.