API Clients

Python Client

At the moment, the only available client for interview suite API is written in Python can is available in the following URL:

https://gitlab.viasto.com/mbrandao/vis-api-client/

Example usage

from vis_api_client import VisApiClient

client = VisApiClient(base_url='https://interview-suite.com/api/v3/',
                      auth_token='0123456789abcdef0123456789abcdef01234567')
client.initialize()
resp = client.projects_list()

in such example, the resp content would be similar to the following:

{
  "meta": {
    "total_count": 1,
    "previous": None,
    "next": None
  },
  "objects": [
    {
      "candidates": "/companies/1/projects/1/candidates/",
      "closedate": None,
      "company": "/companies/1/",
      "creationdate": "2015-02-19",
      "default_interview_period": None,
      "internal_id": None,
      "mode": "rolling",
      "name": "Jack/Jill-of-All-Trades #1",
      "partner_data": {},
      "questions": "/companies/1/projects/1/questions/",
      "resource_uri": "/companies/1/projects/1/",
      "status": "10-incomplete",
      "support_lang": "en",
      "contact_person": None,
      "max_interview_time": 0,
      "videos": [],
      "maximum_score": 5,
      "allow_hash_login": False,
      "invite_candidates": True
    }
  ]
}

It’s important to state that calling method client.initialize() is important as it is responsible to request the API’s root endpoint to initialize basic root URLs for the client.