myinterview

MyInterview-node

The documentation for the myInterview API can be found here.

Prerequisites

This project requires NodeJS (version 14 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.14.15
v14.18.1

Install

npm i myinterview

:warning: Do not use this Node.js library in a front-end application. Doing so can expose your myInterview credentials to end-users as part of the bundled HTML/JavaScript sent to their browser.

Usage

Basic configuration

import { MyInterviewApi } from 'myinterview';
// or 
const { MyInterviewApi } = require('myinterview');

MyInterviewApi.setConfig({
  secret: 'yoursecret',
  companyId: 'yourcompanyid',
  accessKey: 'youraccesskey',
});

To use the SDK you have to set the configuration with the keys provided by myinterview prior use of the classes.

Responses (Regular/Error)

Standard Response

IApiResponseObj

Field	Type	Description
statusCode	number	Status code of the response
errorCode	number	Internal error code
statusReason	string	Info message of the response
callId	string	Internal call ID
data	any	This field contain the data required based on the request
time	Date / number	Timestamp

This is the response object you will receive from the SDK the content of data will change based on your request.

Standard Error Response

IApiResponseObj

Field	Type	Description
*errorMessage	string	Error message
errorDetails	string	Error message details
*statusCode	number	Status code of the response
*errorCode	number	Internal error code
*statusReason	string	Info message of the response
*callId	string	Internal call ID
*time	Date / number	Timestamp
*required field

Candidates

import { Candidates } from 'myinterview';
// or 
const { Candidates } = require('myinterview');

getCandidate

const res =  await Candidates.getCandidate('candidate_id');

const candidate = res.data;

getJobCandidates

const body = {
  job_id: "job_id",
  query: {
    ids: ['candidate_id1', 'candidate_id2'],
    email: '[e-mail]',
    status: 'pending',
    username: 'username',
    skip: 0,
    limit: 20,
  }
};

const res = await Candidates.getJobCandidates(body);

const candidates = res.data;

getJobCandidates Params

getJobCandidatesBody

Field	Type	Description
*job_id	string	ID of the job
communication	object	Query object
query.ids	string array	ids of candidates you need
query.email	string	email of candidate you need
query.status	string	status of the candidate enum (pending, clicked, completed, cancelled)
query.username	string	username of candidate you need
query.skip	number	Pagination
query.limit	number	Pagination
*required field

createBulkCandidates

const body = {
  job_id: "job_id",
  communication: false,
  deadlineDate: "2021-10-20T08:42:59.537+00:00",
  timezoneForInvite: "Australia/Sydney",
  candidates: [{
    username: "username", 
    email: "[e-mail]",
    jobTitle: "Job title",
  }]
};

await Candidates.createBulkCandidates(body);

createBulkCandidates Params

createBulkCandidatesBody

Field	Type	Description
*job_id	string	ID of the job to connect the candidate
communication	boolean	Flag to send mails with the creation
deadlineDate	Date / string / number	Deadline date for the candidate/s
timezoneForInvite	string	Timezone for the deadline
*candidates	Array of candidate object	Array of candidate objects definition is above in the interface
*required field

This call will create one or more candidates and connect them to your Job.

updateCandidate

const body = {
  id: "candidate_id", // You have to provide the id of the candidate
  username: "username",
  email: "[e-mail]",
  jobTitle: "Job title",
};

await Candidates.updateCandidate(body);

updateCandidate Params

updateCandidateBody

Field	Type	Description
*id	string	ID of the candidate
status	string	Status of the candidate
username	string	Username of the candidate
deadline	Date / string / number	Deadline date for the candidate/s
timezoneForInvite	string	Timezone for the deadline
*required field

Companies

import { Companies } from 'myinterview';
// or 
const { Companies } = require('myinterview')

getCompanyInfo

const res = await Companies.getCompanyInfo();

const companyInfo = res.data;

getCompanyTemplates

const res = await Companies.getCompanyTemplates();

const templates = res.data;

createCompanyTemplateBulk

const body = [{
  id: "template_id",
  name: "template_name",
  questions: [{
    numOfRetakes: 1,
    partDuration: 30,
    question: "How are you today?"
  }],
  introVideo: 'youtube.com/watch'
  },
  {
  id: "template_id",
  name: "template_name",
  questions: [{
    numOfRetakes: 1,
    partDuration: 30,
    question: "How are you today?"
  }],
  introVideo: 'youtube.com/watch'
}]

await Companies.createCompanyTemplateBulk(body);

createCompanyTemplateBulk Params

createCompanyTemplateBulkBody

Field	Type	Description
*id	string	ID of the company template
hideQuestions	boolean	hideQuestions flag
*name	string	Name of the template
introVideo	string	Url of the introduction video on the application page
*questions	Array of job questions	Array of job questions objects definition is above in the interface
*required field

updateCompanyTemplate

const body = {
  id: "template_id",
  name: "template_name",
  questions: [{
    numOfRetakes: 1,
    partDuration: 30,
    question: "How are you today?"
  }],
  introVideo: 'youtube.com/watch'
  };

await Companies.updateCompanyTemplate(body);

updateCompanyTemplate Params

updateCompanyTemplateBody

Field	Type	Description
*id	string	ID of the company template
hideQuestions	boolean	hideQuestions flag
name	string	Name of the template
introVideo	string	Url of the introduction video on the application page
*questions	Array of job questions	Array of job questions objects definition is above in the interface
*required field

Jobs

import { Jobs } from 'myinterview';
// or 
const { Jobs } = require('myinterview')

getCompanyInfo

const res = await Jobs.getJobs();

const jobs = res.data;

getJobsWithIds

const ids = ['id1', "id2"]

const res = await Jobs.getJobsWithIds(ids);

const jobs = res.data;

getJob

const id = "id"

const res = await Jobs.getJob(id);

const job = res.data;

createJob

const body = {
  title: "job_title",
  language: 'en',
  overlay: '#000000',
  config: {
    hideQuestions: true,
    practice: true
  },
  jobDescription: 'jobDescription',
  logo: "logo.url.com",
  questions: [{
      numOfRetakes: 1,
      partDuration: 30,
      question: "How are you today?"
  }],
}

await Jobs.createJob(body);

createJob Params

createJobBody

Field	Type	Description
*title	string	Title of the job
language	string	Language of the job
overlay	string	Overlay of the of the application page (Value in Color Hexa #000000)
termsUrl	string	Url of the Terms of Service
privacyUrl	string	Url of the Privacy
backgroundImage	string	Background Image of the of the application page
transcriptLanguage	string	Language of the transcript video
*config	Config Object	Configuration object definition is above in the interface
deadlineDate	Date / string / number	Deadline date for the job
experience	string	experience of the job
jobDescription	string	Job description
logo	string	Logo
*questions	Array of job questions	Array of job questions objects definition is above in the interface
skills	Array of string	skills
introVideo	string	introduction video for application page
*required field

createJobCandidatesWithTemplate

const body = {
  template_id: 'template_id',
  title: "job_title",
  language: 'en',
  overlay: '#000000',
  config: {
    practice: true
  },
  jobDescription: 'jobDescription',
  logo: "logo.url.com",
  candidates: {
    communication: true,
    deadlineDate: "2021-10-20T08:42:59.537+00:00",
    timezoneForInvite: "Australia/Sydney",
    candidates: [{
      username: "username",
      email: "[e-mail]",
    }]
  }
}

await Jobs.createJobCandidatesWithTemplate(body);

createJobCandidatesWithTemplate Params

createJobCandidatesWithTemplateBody

Field	Type	Description
*template_id	string	ID of the template
title	string	Title of the job
language	string	Language of the job
overlay	string	Overlay of the of the application page (Value in Color Hexa #000000)
termsUrl	string	Url of the Terms of Service
privacyUrl	string	Url of the Privacy
backgroundImage	string	Background Image of the of the application page
transcriptLanguage	string	Language of the transcript video
config	Config Object	Configuration object definition is above in the interface
deadlineDate	Date / string / number	Deadline date for the job
experience	string	experience of the job
jobDescription	string	Job description
logo	string	Logo
skills	Array of string	skills
introVideo	string	introduction video for application page
*required field

createJobWithCandidates

const body = {
  title: "job_title",
  language: 'en',
  overlay: '#000000',
  config: {
    practice: true
  },
  jobDescription: 'jobDescription',
  logo: "logo.url.com",
  candidates: {
    communication: true,
    deadlineDate: "2021-10-20T08:42:59.537+00:00",
    timezoneForInvite: "Australia/Sydney",
    candidates: [{
      username: "username",
      email: "[e-mail]",
    }]
  }
}

await Jobs.createJobWithCandidates(body);

createJobWithCandidates Params

createJobWithCandidatesBody

Field	Type	Description
*title	string	Title of the job
*questions	Array of job questions	Array of job questions objects definition is above in the interface
language	string	Language of the job
overlay	string	Overlay of the of the application page (Value in Color Hexa #000000)
termsUrl	string	Url of the Terms of Service
privacyUrl	string	Url of the Privacy
backgroundImage	string	Background Image of the of the application page
transcriptLanguage	string	Language of the transcript video
config	Config Object	Configuration object definition is above in the interface
deadlineDate	Date / string / number	Deadline date for the job
experience	string	experience of the job
jobDescription	string	Job description
logo	string	Logo
skills	Array of string	skills
introVideo	string	introduction video for application page
*required field

updateJob

const body = {
  job_id: 'job_id',
  title: "job_title",
  language: 'en',
  overlay: '#000000',
  config: {
    hideQuestions: true,
    practice: true
  },
  jobDescription: 'jobDescription',
  logo: "logo.url.com",
  questions: [{
    numOfRetakes: 1,
    partDuration: 30,
    question: "How are you today?"
  }],
}

await Jobs.updateJob(body);

updateJob Params

updateJobBody

Field	Type	Description
*job_id	string	ID of the job
title	string	Title of the job
language	string	Language of the job
overlay	string	Overlay of the of the application page (Value in Color Hexa #000000)
termsUrl	string	Url of the Terms of Service
privacyUrl	string	Url of the Privacy
backgroundImage	string	Background Image of the of the application page
transcriptLanguage	string	Language of the transcript video
config	Config Object	Configuration object definition is above in the interface
deadlineDate	Date / string / number	Deadline date for the job
experience	string	experience of the job
jobDescription	string	Job description
logo	string	Logo
questions	Array of job questions	Array of job questions objects definition is above in the interface
skills	Array of string	skills
introVideo	string	introduction video for application page
*required field

Videos

import { Videos } from 'myinterview';
// or 
const { Videos } = require('myinterview')

getVideo

const body = {
    video_id: 'video_id',
    ai: true,
    transcript: true
}

const res = await Videos.getVideo(body);

const video = res.data;

getVideoParams

getVideoBody

Field	Type	Description
*video_id	string	ID of the Video
ai	boolean	add ai object to the video object
transcript	boolean	add transcript object to the video object
*required field

getVideos

const body = {
    ai: true,
    transcript: true,
    username: 'any username',
    email: "[e-mail]",
    skip: 0,
    limit: 20
}

const res = await Videos.getVideos(body);

const videos = res.data;

getVideosParams

getVideosBody

Field	Type	Description
ai	boolean	add ai object to the video object
transcript	boolean	add transcript object to the video object
username	string	get with specific username
email	string	get with specific email
skip	number	for pagination
limit	number	for pagination
*required field

getJobVideos

const body = {
  job_id: 'job_id',
  query: { // This object is not mandatory
    apiKey: 'apiKey',
    clicked: true,
    uploaded: true,
    completed: true,
    email: "[e-mail]",
    username: "exemple",
    candidate_id: "candidate_id",
    language: "en",
    skip: 20,
    limit: 20
  }
}

const res = await Videos.getJobVideos(body);

const videos = res.data;

getJobVideos Params

getJobVideosBody

Field	Type	Description
*job_id	string	ID of the job
query	Query Object	Query object definition is above in the interface
*required field

Webhooks

import { Webhooks } from 'myinterview';
// or 
const { Webhooks } = require('myinterview');

testWebhook

const body = {
  url: 'https://webhook.test',
}

const res = await Webhooks.testWebhook(body);

testWebhook Params

testWebhookBody

Field	Type	Description
*url	string	webhook url
*required field

createWebhook

const body = {
  url: 'https://webhook.io',
}

const res = await Webhooks.createWebhook(body);

createWebhook Params

createWebhookBody

Field	Type	Description
*url	string	webhook url
*required field

Error Handling

You can catch the error the same way you catch error normally.

Async/Await

try {
  const res = await Videos.getVideoPersonality("");
} catch (error) {
  // The error will be of type IApiErrorObj the definition is above.
  console.log(error)
}

Callback

Videos.getVideoPersonality("").then((res) => {
    // Type IApiResponseObj 
}).catch((error) => {
    // The error will be of type IApiErrorObj the definition is above.
    console.log(error)
})

Authentication Helper for API

populateHeaders

This call will populate the headers you need to connect to the global API service it will return an object that you can use in you request. In order to authenticate to the API you need to populate the headers (x-myinterview-timestamp, x-myinterview-key, x-myinterview-signed) the populateHeaders method will return an object that you need to include in the headers config.

import { MyInterviewApi } from 'myinterview';

MyInterviewApi.populateHeaders({
  secret: 'yoursecret',
  companyId: 'yourcompanyid',
  accessKey: 'youraccesskey',
});

It will return:

{
    'x-myinterview-timestamp': 'headTimestamp', 
    'x-myinterview-key': 'headKey',
    'x-myinterview-signed': 'headSigned'
}

Authors

• Dvd1109 (David Sellam)