Skip to main content

Legal

Tax & Accounting

Trade & Supply

Risk & Fraud

News & Media

Books

Developers

API

Get started with GoFileRoom API services

Steps to get started

  1. Access the Developer Portal. Sign up and create an account on the Developer Portal.
    2. Select
      Register
      . This step of the process grants you access to API documentation and learning content.
    3. Use an email domain from your firm when registering, so that we can validate your request and identify your firm. Wait 1-2 business days for approval.
  2. Get your API Key. Thomson Reuters issues to your firm.
    1. Once you've registered, you'll need to contact our support to request an API key.
      Email gfrapikeys@thomson.com with the Firm name, Firm ID, Database ID, and the name and email address of the person requesting the API key. The API team will create the key if necessary, and provide access to the customer. When this is completed, you'll get an email letting you know and then you'll follow these steps:
      1. Let the customer know they can access their API key in the Thomson Reuters Developer Portal. The email address must exactly match the one used for the API key.
      2. Sign in to your TR Development Portal account, or create one using the
        Register
         button.
        note
        If the customer doesn't already have an account, email gfrapikeys@thomson.com to approve access. They are NOT automatically notified when account access is requested.
      3. If creating a new account, make sure to check your email and verify your email address. The email will come from TRIdentity@thomsonreuters.com.
      4. Select
        My Apps
         in the menu bar.
      5. If you do not see the company name (formatted as GFR-FirmName), select
        Company Invitations
         and accept the invite to access the company.
      6. Select the company, and then select the name in the dropdown menu to display the AP key.
    2. Support will get evidence to validate and approve the permissions of the person requesting the API key.
    3. When this is complete, you'll receive an email with steps on how to proceed. This process can take up to 24 hours.
    4. Then, you can access the API keys through the
      My Keys
       section within the Developer Portal.
  3. Have a GoFileRoom Username and Password.
    • Make sure that the GoFileRoom username you're using has permissions to make changes or access the areas meant to be affected.
    • Usually, the role of this user is an administrator.
  4. Download and install a web debugging tool like Fiddler or Postman.
    • Select the link to go to the debugging tool of your choice.
    • If you’ve installed Postman, go to https://developerportal.thomsonreuters.com/home and select the
      Using the GoFileRoom Postman Collection & Environment
       document.
    • Follow the steps, for this one-time setup, to configure the Collection and Environment within Postman.
      note
      This article uses the Postman debugging tool to illustrate how you can connect, authenticate, and create a simple request.
  5. Review the Thomson Reuters Learning resources available.
    • Get and review GoFileRoom API Documentation. Search for the respective GoFileRoom API documents on the developer portal: GoFileRoom API.
    • Let us do the heavy lifting. Did you know that our consulting teams are on stand by to help your team with training, resources, and customized work related to your API development? If interested, contact your account representative at Thomson Reuters.
  6. (Optional) If your firm needs a User Acceptance Testing (UAT) environment, contact support.
    • A GoFileRoom User Acceptance Testing (UAT) environment gives firms a space to test functionality for APIs, applications built by the firm, or third parties within a GoFileRoom database. This assures API projects have no impact on your firms everyday production database.
    • If your API team plans to test outside of your GoFileRoom application environment, we recommend that you set up this UAT (also known as Sandbox).
    • What information do I need to bring to support if I need a UAT environment?
      For security reasons, you need to send the request on the company letterhead, and contain the following information:
      • You need to send the confirmation from the firm’s email domain.
      • The letter needs to contain today’s date.
      • The letter needs to contain the signature of the person submitting the request.
      • Example evidence:
        I, <name>, firm <licensee or delegate> for <Firm Name> (Firm ID: < firm ID>) would like to request a UAT environment for my firm. Set up <Employee Name> (Email: <firm email address>) as the UAT Database admin.

Variables

Name
UAT Environment Value
Production Environment Value
baseURL
username
Your UAT username.
Your production username.
password
Your UAT password.
Your production password.
apiToken
The token used to sign in to GoFileRoom.
The token used to sign in to GoFileRoom.

Acquire an API token

You need an API token to call GoFileRoom services. Follow these steps to acquire a token.
  1. Open your web debugging tool, such as Postman, then open a new tab in your web browser.
  2. Select
    Post
     as the HTTP verb, then enter
    [baseURL]/api/v1/user/login
     for the URL.
    Example of a base URL
  3. Select the
    Headers
     tab, then enter
    application/json
     for
    Content Type
     and your API key for
    X-TR-API-APP-ID
    .
  4. Select the
    Body
     tab, then choose the
    raw
     option.
  5. Enter your username for the LoginName and password for the Password.
  6. Enter
    en
     for the Language,
    ""
     for Captcha, and
    0
     for CaptchaType.
    Example of JSON information entered in the text field in the Body tab.
  7. Select
    Send
    .
If your request was successful, you'll have a token value and authSuccess will be True. Copy the value in the token field, and save it as an apiToken to use with other GoFileRoom services.

Call a List Drawers service with API

After acquiring an API token, you can call various GoFileRoom services. Use the following example of a simple call to view the list of drawers available to you.
The GoFileRoom developer community contains a list of services you can use with the GoFileRoom API.
  1. Open a new tab in your web browser.
  2. Select
    GET
     as the HTTP verb, and enter
    [baseURL]/api/v1/user/login
     for the URL.
    Example of URL.
  3. Select the
    Headers
     tab, then enter
    Basic [apiToken]
     for
    Authorization
     and your API key for
    X-TR-API-APP-ID
    . Example of values entered for the Authorization and X-TR-API-APP-ID keys.
  4. Select
    Send
     to submit your request to the API service. If successful, the response message should contain a list of available drawers.
    You can call other GoFileRoom services in a similar fashion to the List Drawers service, using the standard HTTP verbs (GET, POST, PUT [PATCH], DELETE). For these services, remember to include the same headers as described in step 3.

error-icon

error-close