Logging in to Anno-REP Detailed Instructions

Logging in to Anno-REP Step by Step

This guide is meant to clarify and assist with the login procedure for the Anno-REP platform. Scroll down for step-by-step instructions with images.

Getting Started

Unlike other platforms, Anno-REP doesn't have its own username and password for you to log in with. This is because the program works by interacting with two other platforms, namely your manuscript and data on the Qualitative Data Repository and the annotating power of Hypothes.is. Anno-REP does this by using Application Programming Interface tokens, referred to here as API tokens. Your API tokens are what gives Anno-REP access to your accounts on these two platforms (QDR and Hypothes.is), sort of like if you had given Anno-REP your username and password for these platforms but with less steps.

This means that, in order to log in to Anno-REP and give it access to your QDR and Hypothes.is platforms, you need to do the following:

1. Obtain your API keys for both of these platforms
2. Enter the keys into the Anno-REP login page

Scroll down on this page for step by step instructions on how to do this. Please note: an API key is a long string of numbers and letters that is unique to you and your account on one of these websites. Just as Anno-REP uses the API key to interact with these sites for you, anybody that has your API key can also access all of your information, just as if you had given them your username and password. As such, make sure you keep your API keys secret just like you would a password!

Logging In

• First, navigate to the Anno-REP homepage at anno-rep.org and click the button that says "Login to create a new ATI Project."
  • You can also click the "Login" button in the top right corner of the screen.

• On the Anno-REP login page, you should see the prompts for your QDR API token and your Hypothes.is API token. Keep this tab open - when you obtain your tokens, you'll navigate back here and paste them in these boxes:

• Next, let's walk through obtaining each of these keys.

Obtaining Your QDR API Token

• First, you need to log into QDR if you haven't done so already.
  • Navigate to the QDR homepage at https://qdr.syr.edu and click the Login button in the top right corner of the screen.
  • You can also navigate to the login screen directly directly by going to: https://qdr.syr.edu/user/login
  • Once you're there, enter your QDR username and password and click "Login."
  • Note: if only the "Logout" button is present on the homepage, you are already logged in!

• Direct Link

  • The easiest way to get to your QDR API token is to just click the link on the Anno-REP Login page. You can also click here.

• Navigating Manually

  • If for some reason the link doesn't work for you, you can also navigate manually to the API Token page from the QDR website.
  • After logging in on the QDR website, click the drop-down menu button in the top left corner (AKA the "hamburger button").

• • Click "My Data."

• • Click on the "API Token" tab.

• Getting your token

  • Once you successfully navigate to the QDR API Token page, you should either see your token as a long string of numbers and letters, or a message similar to "API Token has not been created."
  • To create an API token if one is not displayed, click "Create Token."

• • Once you have your token, which should appear as a long string of numbers and letters, you can copy it to your clipboard and navigate back to the Anno-REP login screen to paste it.
    • You can also choose to recreate your token, which will revoke your current token and provide a new one.
    • You can also choose to revoke your token entirely. Note that a revoked token will no longer provide access to your QDR account and can no longer be used to log into Anno-REP.
      • If you recreate your token, you will need to re-log into Anno-REP.
    • Make sure to treat your token with privacy and care!

Obtaining Your Hypothes.is API Token

• Like QDR, you need to first be logged in to Hypothes.is to obtain your API token.
  • Navigate to the Hypothes.is main page at https://web.hypothes.is/
  • If this is your first time using Hypothes.is, click the "Get Started" button at the top-right of the screen and follow the instructions to create your account and install the extension.
    • You will need this extension to annotate in Anno-REP.
  • Otherwise, click "Log In" and log in to Hypothes.is.

• Direct Link

  • Like with the QDR, the easiest way to navigate to the Hypothes.is API token page is to click the link on the Anno-REP login page. You can also click here.

• Navigating Manually

  • If the link doesn't work for you, or you need to otherwise manually navigate to your Hypothes.is API key, you can do so from the Hypothes.is website.
  • After logging in to the Hypothes.is website, click the "Settings" icon in the top right corner of the screen (the button shaped like a gear) and click "Developer."

• • The "Developer" button should take you directly to the API token page.

• Getting Your Token

  • Once you successfully navigate to the Hypothes.is API Token page, you should see your token as a long string of numbers and letters.

• • Once you have your token, which should appear as a long string of numbers and letters, you can copy it to your clipboard and navigate back to the Anno-REP login screen to paste it.
    • You can also choose to regenerate your token, which will revoke your current token and provide a new one. Note that the old token will no longer provide access to your Hypothes.is account and can no longer be used to log into Anno-REP.
      • If you regenerate your token, you will need to re-log into Anno-REP.
    • Make sure to treat your token with privacy and care!

After you have pasted both of your API tokens into the Anno-REP login page, click the "Login" button. You should now be logged in and ready to start annotating.

If you are still having trouble logging in, visit our FAQ and Troubleshooting page or contact QDR.