Sample Code with HMAC Authentication Examples
Below you will find example scripts for communicating with Interfolio Faculty Activity Reporting (FAR), Faculty Search (FS), and Review, Promotion, & Tenure (RPT) APIs. Each script includes an example code to complete the required HMAC authentication.
Using Sample Code
All of the resources on this page are examples of how to connect and make an API call to an Interfolio service. They are a starting point for your integration work. Each of the scripts linked below will require a set of public and private API keys in order to work. Faculty Search and Review, Promotion, & Tenure examples will require your Interfolio tenant ID. Faculty Activity Reporting examples will require your database ID.
Standard libraries and functions are used wherever possible.
Resources
In addition to the many popular programming and scripting languages below, we also provide a Postman collection for testing Interfolio REST APIs. Browse the following list for the language you intend to use and available sample scripts.
| Language/Tool | Sample Scripts | |
|---|---|---|
| Python3 | far_example.py | fsrpt_example.py |
| Ruby | far_example.rb | fsrpt_example.rb |
| PHP | FAR_example.php | FSRPT_example.php |
| Java | FarExample.java | FsRptExample.java |
| C# | FAR_example.cs | FSRPT_example.cs |
| Perl | HMAC_API_Access_Control_PERL_example.pl | |
| PowerShell | HMAC_API_Access_Control_PowerShell.ps1 | |
| Postman |
API Example Calls Collection
|
Template Environment
|
Notes on Postman
The sample API calls Postman collection is not designed to be run by a collection runner. Rather it is a grouping of example calls to each of the various Interfolio module APIs. Downloading the template environment is recommended. If you have both a production and development Interfolio tenant it is useful to define those environments individually with Postman to move quickly between the two.
More information about editing pre-request scripts in Postman and the use of environments in Postman is available from the Postman documentation web site.