RetroTax

Authentication

Authentication Overview

{
  "username": "foo",
String

login name of user

  "first_name": "foo",
String

First name of user

  "last_name": "foo",
String

Last name of user

  "email": "foo",
String

email of user

  "role": "foo",
String

role of user

  "sub_role": "foo",
String

sub role of user(if current user is hiring manager)

  "auth_token": "foo",
String

Auth Token

  "preffered_language": "foo",
String

Language which user selected

  "help_checkbox": true,
Boolean

help check box enabled or not.

  "benestream_enabled": true,
Boolean

benestream enabled or not

  "client_name": "foo",
String

Name of the client

  "ccl_info": {
  "ccl_info": { ... }
Object

Ccl Info

    "client_id": 42.0,
Number

client id

    "company_id": 42.0,
Number

company id

    "location_id": 42.0
Number

location id

  },
  "ats_enabled": true,
Boolean

ATS mode enabled or not

  "obs_enabled": true,
Boolean

OBS enabled or not

  "display_label": "foo"
String

Client display lable

}

POST /authentication

Open in API Explorer
POST /authentication

Example Request

Format:
curl --request POST \
  --url https://api-qa.retrotax-aci.com/authentication \
  --header 'accept: application/json' \
  --header 'content-type: foo' \
  --header 'x-api-key: foo' \
  --header 'x-auth-iv: foo' \
  --data '{"username":"foo","password":"foo"}'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/authentication")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["content-type"] = 'foo'
request["x-api-key"] = 'foo'
request["x-auth-iv"] = 'foo'
request.body = "{\"username\":\"foo\",\"password\":\"foo\"}"

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "POST",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/authentication",
  "headers": {
    "accept": "application/json",
    "content-type": "foo",
    "x-api-key": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ username: 'foo', password: 'foo' }));
req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

payload = "{\"username\":\"foo\",\"password\":\"foo\"}"

headers = {
    'accept': "application/json",
    'content-type': "foo",
    'x-api-key': "foo",
    'x-auth-iv': "foo"
    }

conn.request("POST", "/authentication", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/authentication",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"username\":\"foo\",\"password\":\"foo\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: foo",
    "x-api-key: foo",
    "x-auth-iv: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/authentication"

	payload := strings.NewReader("{\"username\":\"foo\",\"password\":\"foo\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "foo")
	req.Header.Add("x-api-key", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
Content-Type String Required foo
X-API-KEY String Required foo
X-AUTH-IV String Optional foo

Request Body

Name Type Required Description Example
SignInRequest Object Required
{
  "username": "foo",
String

Username

  "password": "foo"
String

Password

}

Responses

200 OK

200 response

Authentication Sign in response
{
  "username": "foo",
String

login name of user

  "first_name": "foo",
String

First name of user

  "last_name": "foo",
String

Last name of user

  "email": "foo",
String

email of user

  "role": "foo",
String

role of user

  "sub_role": "foo",
String

sub role of user(if current user is hiring manager)

  "auth_token": "foo",
String

Auth Token

  "preffered_language": "foo",
String

Language which user selected

  "help_checkbox": true,
Boolean

help check box enabled or not.

  "benestream_enabled": true,
Boolean

benestream enabled or not

  "client_name": "foo",
String

Name of the client

  "ccl_info": {
  "ccl_info": { ... }
Object

Ccl Info

    "client_id": 42.0,
Number

client id

    "company_id": 42.0,
Number

company id

    "location_id": 42.0
Number

location id

  },
  "ats_enabled": true,
Boolean

ATS mode enabled or not

  "obs_enabled": true,
Boolean

OBS enabled or not

  "display_label": "foo"
String

Client display lable

}
202 Accepted

202 response

(Empty Response)
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)

DELETE /authentication

Open in API Explorer
DELETE /authentication

Example Request

Format:
curl --request DELETE \
  --url https://api-qa.retrotax-aci.com/authentication \
  --header 'accept: application/json' \
  --header 'x-api-key: foo' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/authentication")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["accept"] = 'application/json'
request["x-api-key"] = 'foo'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/authentication",
  "headers": {
    "accept": "application/json",
    "x-api-key": "foo",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

headers = {
    'accept': "application/json",
    'x-api-key': "foo",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("DELETE", "/authentication", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/authentication",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "x-api-key: foo",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/authentication"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("x-api-key", "foo")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
X-API-KEY String Required foo
X-AUTH-TOKEN String Required foo
X-AUTH-IV String Optional foo

Responses

200 OK

200 response

(Empty Response)
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)

GET /authentication/user_details

Open in API Explorer
GET /authentication/user_details

Example Request

Format:
curl --request GET \
  --url https://api-qa.retrotax-aci.com/authentication/user_details \
  --header 'accept: application/json' \
  --header 'x-api-key: foo' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/authentication/user_details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["x-api-key"] = 'foo'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/authentication/user_details",
  "headers": {
    "accept": "application/json",
    "x-api-key": "foo",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

headers = {
    'accept': "application/json",
    'x-api-key': "foo",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("GET", "/authentication/user_details", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/authentication/user_details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "x-api-key: foo",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/authentication/user_details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("x-api-key", "foo")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
X-API-KEY String Required foo
X-AUTH-TOKEN String Required foo
X-AUTH-IV String Optional foo

Responses

200 OK

200 response

Authentication Sign in response
{
  "username": "foo",
String

login name of user

  "first_name": "foo",
String

First name of user

  "last_name": "foo",
String

Last name of user

  "email": "foo",
String

email of user

  "role": "foo",
String

role of user

  "sub_role": "foo",
String

sub role of user(if current user is hiring manager)

  "auth_token": "foo",
String

Auth Token

  "preffered_language": "foo",
String

Language which user selected

  "help_checkbox": true,
Boolean

help check box enabled or not.

  "benestream_enabled": true,
Boolean

benestream enabled or not

  "client_name": "foo",
String

Name of the client

  "ccl_info": {
  "ccl_info": { ... }
Object

Ccl Info

    "client_id": 42.0,
Number

client id

    "company_id": 42.0,
Number

company id

    "location_id": 42.0
Number

location id

  },
  "ats_enabled": true,
Boolean

ATS mode enabled or not

  "obs_enabled": true,
Boolean

OBS enabled or not

  "display_label": "foo"
String

Client display lable

}
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)