Getting Started
API Inroduction
ITN DB API allows your placement, filling and visa procedure for Exchange Visitor program from registration to come back their home country.
API Authorization
Every API request authenticated with JWT Token.
JWT Token
JSON Web Token (JWT) is an open standard for securely transmitting information between parties as JSON object.
To Generate your JWT Token please contact your administrator to get an API User and API key.
After generate your API User and API Key you must authenticate your credentials and generate JWT Token using API Call https://apiuser.beta.itndatabase.com/api_call_list#L_generateToken.
API Call Default Parameter
- act: Use exactly same value for act with following APIs, either one of listed values below act input or the auto filled value.
Generate Token
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-login;
Payload:
{
"APIUser":api_user1@yopmail.com,
"APIKey":***********
}
Response:
{
"status":"success",
"message":"Login Successful.",
"data": [{ "token":"*********" }]
}
Country Listing
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-response;
HEADER: Authorization: Bearer $token;
Payload:
{
"act":getCountries,
"country_id":1
}
Response:
{
"status":"success",
"message":"",
"data": [{ "country_id":"1","country_name":"Afghanistan","country_code":"AF" }, { "country_id":"2","country_name":"Albania","country_code":"AL" }, { "country_id":"3","country_name":"Algeria","country_code":"DZ" }, ...]
}
Parameters:
- country_id:: int - country_id is optional parameter. If you need particular country details then you need to pass country_id parameter in payloads.
DOS Program Category
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-response;
HEADER: Authorization: Bearer $token;
Payload:
{
"act":getDOSProgramCategory
}
Response:
{
"status":"success",
"message":"",
"data": [{ "dos_program_category_id":"1","program_category_name":"Intern","program_number":"P-4-29241","program_number_beta":"P-4-23436", "PositionCode":"215","PositionCode2":"214","CategoryCode":"15","userID":"bmagka9268", "userID_beta":"fbrebi8499" }, { "dos_program_category_id":"2","program_category_name":"Trainee","program_number":"P-4-29242","program_number_beta":"P-4-25536","PositionCode":"314","PositionCode2":"900","CategoryCode":"14","userID":"bmagka9268","userID_beta":"fbrebi8499"} ]
}
Time Zone Listing
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-response;
HEADER: Authorization: Bearer $token;
Payload:
{
"act":getTimezones
}
Response:
{
"status":"success",
"message":"",
"data": [{ zone_id":"374","is_active":"1","is_valid_zone":"1","gmt_offset":"-39600","abbreviation":"SST","abbreviation_name":"SAMOA STANDARD TIME (American Samoa)","offset_utc":"UTC - 11","zone_name":"Pacific\/Midway","country_code":"UM","country_name":"United States Minor Outlying Islands","zone_label":"SAMOA STANDARD TIME (American Samoa) (SST) [Pacific\/Midway] UTC - 11"}, { "zone_id":"404","is_active":"1","is_valid_zone":"1","gmt_offset":"-36000","abbreviation":"HST","abbreviation_name":"HAWAII STANDARD TIME","offset_utc":"UTC - 10","zone_name":"Pacific\/Honolulu","country_code":"US","country_name":"United States","zone_label":"HAWAII STANDARD TIME (HST) [Pacific\/Honolulu] UTC - 10"}, { "zone_id":"284","is_active":"1","is_valid_zone":"1","gmt_offset":"-34200","abbreviation":"MART","abbreviation_name":"MARQUESAS TIME","offset_utc":"UTC - 9:30","zone_name":"Pacific\/Marquesas","country_code":"PF","country_name":"French Polynesia","zone_label":"MARQUESAS TIME (MART) [Pacific\/Marquesas] UTC - 9:30"},... ]
}
Parameters:
- zone_id:: int - zone_id is optional parameter. If you need particular zone details then you need to pass zone_id parameter in payloads.
- country_code:: int - country_code is optional parameter. If you need particular country details with time zone then you need to pass country_code parameter in payloads.
Program Listing
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-response;
HEADER: Authorization: Bearer $token;
Payload:
{
"act":getProgramList,
"dos_program_category_id":1
}
Response:
{
"status":"success",
"message":"",
"data": [{ "program_id":"3","sponsor_id":"0","program_name":"Full Placement - Trainee Recent Graduate","enroll_program_id":"22","dos_program_category_id":"2","status":"1","programe_fee_invoice_type":"0","category":"1","category_order":"3","program_order":"0","total_placement":"1","program_filter_category":"2","allow_update_program":"1"},{ "program_id":"4","sponsor_id":"0","program_name":"Full Placement - Trainee Young Professional","enroll_program_id":"36","dos_program_category_id":"2","status":"1","programe_fee_invoice_type":"0","category":"1","category_order":"4","program_order":"0","total_placement":"1","program_filter_category":"2","allow_update_program":"0"} ]
}
// Note: zone_id is optional parameter. If you need particular zone details then you need to pass zone_id parameter in payloads.
// Note: country_code is optional parameter. If you need particular country details with time zone then you need to pass country_code parameter in payloads.
Parameters:
- dos_program_category_id:: int - A dos program category id which you can find through getDOSProgramCategory API Call.
Register User
METHOD: POST
API URL: https://apiuser.beta.itndatabase.com/api-response;
HEADER: Authorization: Bearer $token;
Payload:
{
"act":newUserRegister,
"dos_program_category_id":"1",
"program_id":"1",
"first_name":"Hetal",
"last_name":"Visaveliya",
"email_address":"hetal_visaveliya@yopmail.com",
"candidate_timezone":192,
"country_citizen":90,
"country_resident":90,
"birth_city":rajkot,
"birth_country":90,
"birth_date":1991-02-07,
"job_number":012345678,
"resume":curl_file_create($tmpfile, $filetype, $filename)
}
Response:
{
"status":"success",
"message" : "Your account created successfully.",
"data" : { [] }
}
Parameters:
- dos_program_category_id:: int - A dos program category id which you can find through getDOSProgramCategory API Call.
- program_id:: int - A program id which you can find through getProgramList API Call.
- candidate_timezone:: int - A candidate timezone id which you can find through getTimezones API Call.
- All Country ID [country_citizen, country_resident, birth_country]:: int - A country id which you can find through getCountries API Call.
- job_number:: varchar - A job number is provided by your host company exachange position.
Note:
All API Call with format find out in below url https://apiuser.beta.itndatabase.com/api_call_list