How do I get started with Cayuse and Researcher Solutions APIs?

What is the purpose of this article?

This article is intended to serve as a quick reference for common questions and provide clear, concise answers. If your question is not addressed here, please contact us via support.cayuse.com

Where can I find more detailed information?

More comprehensive details can be found in the Reporting and REST API guides

Is there a list of available APIs?

Researcher Solutions APIs

• Researcher-specific APIs include the REST API and the Reporting API:
  • REST API: 
    • Objects API 
      • GET information about any “object” (e.g. a workflow) and documents around the object. 
        • See documentation for available endpoints.
    • Users API
      • GET more information about any user.
        • See documentation for available endpoints.
    • Files API
      • To GET more information about a file in the system as well as a download URL for that file.
        • See documentation for available endpoints.
  • Reporting API:
    • Collections API
      • GET information about all collections (think: tables) available.
    • Collection API
      • GET information about one specific collection (the fields in a table).
    • Collection-Data API
      • GET all the data held in one specific collection.

Cayuse Platform — Organisational data load (Admin/HR Connect)

• Loading organisational data to the Cayuse Platform (e.g. people, users, org units, roles) is achieved using the HR Connect API.
  • A list of available endpoints can be found here: HR Connect: Overview and Best Practices – Cayuse Help Center.

Cayuse Platform — Admin Module REST API

• The Cayuse Platform also includes an Admin Module REST API for interacting with the organisational data after it was loaded with HR Connect. 
  • A list of the available APIs can be found here: Admin Module Public APIs – Cayuse Help Center.

How do you access the APIs?

Researcher Solutions APIs

• In order to access the Researcher APIs you will first need to generate an API Key in the system. 
  • These keys are specific to the API you are wanting to access (e.g. separate API Keys for the REST and Reporting APIs).
  • The process of obtaining an API Key is explained in more detail in
    • How does the Researcher Solutions (Haplo) REST API work? – Cayuse Help Center
    • How does the Researcher Solutions (Haplo) Reporting API work? – Cayuse Help Center

Cayuse Platform — Organisational data load (Admin/HR Connect)

• In order to access HR Connect for loading data, you need to obtain an authentication token via the Authentication endpoint.
  • See HR Connect: Authentication – Cayuse Help Center for more information.
  • You will use this token for all subsequent requests to HR Connect – Cayuse Help Center

Cayuse Platform — Admin Module REST API

• In order to access the Admin Module REST API, you need to obtain an authentication token via the Authentication endpoint.
  • See Getting Started with Public APIs – Cayuse Help Center for more information.

• You will use this token for all subsequent requests to the Admin Module Public APIs – Cayuse Help Center

Who can access APIs?

This is determined by your System Administrators who control:

• Which users should be given API-specific access roles (aka group membership) in Researcher Solutions. 
  • System Administrators are also responsible for generating the API Keys required for any given user.
• Which users should be given API-specific access roles in Cayuse Admin.