The InterviewUp API platform is based on REST principles and provides simple and powerful web services to interact with our proprietary data, logic, and presentation assets. Our APIS are designed to provide predictable, resource-oriented URLs and HTTP response codes to indicate API errors. Developers can use our unique suite of APIs to create a variety of career services and solutions including custom applications, websites, widgets, and other projects.
All requests and responses are formatted as JSON, including errors.
The media types for Content-Type response header are:
There are two different ways to specifiy versioning:
All API dates and times are returned in ISO 8601 format.
Our APIs use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing), and codes in the 5xx range indicate a problem on our servers.
We provide details about errors in the body of the response in the following format:
|type||a URL to a document describing the error condition|
|title||a brief title for the error condition|
|status||the HTTP status code for the current request|
|detail||error details specific to this request|
One of the key features of the InterviewUp REST API platform is HAL (Hypertext Application Language).
At its core, HAL provides a set of conventions for consistent and easy API interaction through hyperlinks in JSON. With each call you make to the API, we’ll return an array of links that allow you to request more information about a call and to further interact with the API. These are meant to provide explicit links so that API clients don’t need to construct links on their own. HAL links are contextual, so you only get the information that is relative to a specific request.
The media type for the Content-Type response header when using HAL over HTTP is application/hal+json
The example below is how we represent a collection of questions using HAL:
|self||The URI of the main resource being represented expressed with a self link. Each resource will be structured as a HAL resource, and contain at least a “_links” property with a “self” relational link.|
|first||It is pointing to the first page of resources|
|last||It is pointing to the last page of resources|
|prev||It is pointing to the previous page of resources|
|embedded||The embedded property is used to represent other resources (with their own links and properties) embedded in the resource we are representing.|
All of our APIs require authentication. We use OAuth 2.0 to provide authorized access to our APIs. The OAuth 2.0 authorization framework enables a third-party application to obtain limited and secure access to protected resources. With each API call, you'll need to set up your request headers, including an OAuth 2.0 access token. To start making API requests, follow follow these steps