OTAS Integration
Introduction
An API for Integrating with OTAS, getting programs available within our system, creating a student or checking if it's already exist. This document lists available endpoints and explains how you can send request to OTAS
Authorization
All endpoints use API key auth and it should be included on every request no matter what request method it's. it can be included on the form body or the query string of the requested endpoint with the name api_key and the value of jwt-token you'll get issued by the otas system from Settings -> API Clients Management, then on every example below replace [api-key-here] with the token.
Student Check
Check if a student is exist with OTAS system or not, also list their applications on the universities and view the status of each app. the request sample below explain the required params and shows the responses
POST
https://otas.oktamam.info/api/v1/checker
You can check if a student is exist you can send a POST request to this endpoint with the given params or form body
| Key | Value | Description |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| birthdate | 02-02-2000 | Required Student's birth date in format of dd-mm-yyyy |
| passport_no | P123456789 | Required Student's passport number |
Example request:
curl --location --request POST '/checker' \--form 'api_key=[api-key-here]' \--form 'birthdate="31-12-1999"' \--form 'passport_no="P123456789"'Example response:
{ "STATUS": 200, "MESSAGE": "otas.api::messages.student_exist", "DATA": { "exists": 1, "student": { "id": 14582, "name": "TEST TEST", "surname": "TEST", "email": "testtesttest12@test.com", "nationality": "203", "passport_no": "P123456789", "phone": "2390483209", "birthdate": "31/12/1999", "gender": "male", "marital": "Single", "father_name": "test", "father_number": "", "mother_name": "test", "address_aboard": "", "address_inside": "", "visa_country": "203", "is_transfer": 0, "has_blue_card": 0, "has_tc_number": 0, "tc_number": null, "passport_issue_date": "01/01/2020", "passport_expiry_date": "01/01/2025", "applying_for": "Associate", "high_school_name": "TEST", "high_school_g_p_a": "100", "high_school_country": "Sudan", "level_id": 2, "avatar": "https://otas.test/storage/app/uploads/public/63b/a10/c77/63ba10c77e46c796333710.jpg", "files": { "passport": [ { "id": 3, "path": "https://otas.test/storage/app/uploads/public/63b/9fc/5a7/63b9fc5a7303d665074750.png" } ], "diploma": [ { "id": 1, "path": "https://otas.test/storage/app/uploads/public/63b/9fc/4fa/63b9fc4fadd8b606870836.png" } ], "transcript": [ { "id": 2, "path": "https://otas.test/storage/app/uploads/public/63b/9fc/556/63b9fc5563457954204872.png" } ], "blue_card": [], "tc": [], "course_description": [], "skills": [], "ml": [], "rl": [], "other": [] } }, "applications": [ { "id": 29155, "status": "cacceptance", "program": "Associate of Computer Programming (Turkish)", "university": "Istanbul Okan University", "university_logo": null, "updated_at": "12-01-2023", "conditional_acceptance": [ "https://otas.test/storage/app/uploads/public/63b/9fd/337/63b9fd33763f5715397069.png" ], "final_acceptance": [], "show_payment_receipt": 0, "notes": [] } ] }}Programs
List Programs
Query Params:
| KEY | VALUE | DESCRIPTION |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| lang | en | Optional Default: en, Specify in what language the data should be returned |
| degree | 1 | Optional Filter with specific degree (2: Bachelor, 3: Master, etc) returned from settings url |
| language | 1 | Optional Filter with specific study language, returned from settings url |
| school | 11 | Optional Filter with specific school, returned from settings url |
| speciality | 8 | Optional Filter with specific speciality, returned from settings url |
| field | 1 | Optional Filter with specific field, returned from settings url |
| tuition_type | Credit | Optional Filter with specific tuition type, returned from settings url |
| tuition_fees_from | 2000 | Optional Filter with specific start range for tuition |
| tuition_fees_to | 100000 | Optional Filter with specific end range for tuition, returned from |
| title | Bachelor of medicine | Optional Search with title or part of the name of program |
| school_type | 1 | Optional Filter with specific school type, returned from |
| city | 1 | Optional Filter with specific city, returned from |
| country | 246 | Optional Filter with specific country, returned from |
Example Request
curl --location --request GET \'https://otas.oktamam.info/api/v1/programs?lang=en&api_key[api-key-here]°ree=2&language=1'Example Response
{ "STATUS": 200, "MESSAGE": "Process is successfully completed", "DATA": [ { "id": 2178, "title": "Bachelor of Medicine (English)", "school_id": 11, "school_name": "Istanbul Okan University", "school_logo": null, "official_tuition": "25000 USD", "school_profile_url": "https://oktamam.com/en/istanbul-okan-university/", "discounted_tuition": "20500 USD", "active_apps": true, "tuition_type": "Year", "country_id": 221, "level_id": 2, "language": "English", "default_semester": "2", "application_fees": { "amount": 0, "currency": "" }, "notes": null, "gifts": [], "countries": [], "is_quota_available": true, "is_available": true, "level_name": "Bachelor", "speciality_id": 77, "speciality_name": "Medicine", "field_id": 7, "field_name": "Medicine, Dentistry & Health Sciences", "study_years": "6" }, ... ]}Get a single program
Get information of a specific program and all related data of it
GET
https://otas.oktamam.info/api/v1/get-program?api_key=[api-key-here]&lang=en&programId=3900
Query Params
| KEY | VALUE | DESCRIPTION |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| lang | en | Optional Default: en, Specify in what language the data should be returned |
| programId | 3900 | Required Program id to fetch |
Example Request
curl --location --request GET \'https://otas.oktamam.info/api/v1/get-program?lang=en&api_key=[api-key-here]&programId=3900'Example Response
{ "STATUS": 200, "MESSAGE": "Process is successfully completed", "DATA": [ { "id": 3900, "title": "Bachelor of Software Engineering (English)", "school_id": 11, "school_name": "Istanbul Okan University", "school_logo": null, "official_tuition": "6500 USD", "school_profile_url": "https://oktamam.com/en/istanbul-okan-university/", "discounted_tuition": "4400 USD", "active_apps": true, "tuition_type": "Year", "country_id": 221, "level_id": 2, "language": "English", "default_semester": "2", "application_fees": { "amount": 0, "currency": "" }, "notes": null, "gifts": [], "countries": [], "is_quota_available": true, "is_available": true, "level_name": "Bachelor", "speciality_id": 19, "speciality_name": "Technology, Software, Computer, IT", "field_id": 1, "field_name": "Engineering & Technology", "study_years": "4" } ]}List Settings
Get all settings from the system
Query Params
| KEY | VALUE | DESCRIPTION |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| lang | en | Optional Default: en, Specify in what language the data should be returned |
| countries | 1 | Optional returns all countries where we're contracted with universities |
| degrees | 1 | Optional returns all degrees in the system |
| fields | 1 | Optional returns all study fields in the system |
| languages | 1 | Optional returns all study languages in the system |
| schools | 1 | Optional returns all schools in the system |
| schools_types | 1 | Optional returns all schools types in the system |
| tuition_types | 1 | Optional returns all tuition types in the system |
| all_countries | 1 | Optional returns all countries in the system, worldwide countries |
| years | 1 | Optional returns all academic years in the system |
Example Request
curl --location --request GET \'https://otas.oktamam.info/api/v1/settings?api_key[api-key-here]&lang=en&countries=1°rees=1&fields=1&languages=1&schools=1&schools_types=1&tuition_types=1&all_countries=1&years=1'Example Response
{ "STATUS": 200, "MESSAGE": "Process is successfully completed", "DATA": { "countries": [ { "id": 13, "title": "Australia", "cities": [ { "id": 38, "title": "Adelaide" }, { "id": 37, "title": "Brisbane" }, { "id": 33, "title": "Cairns" }, { "id": 39, "title": "Canberra" }, { "id": 36, "title": "Darwin" }, { "id": 35, "title": "Gold Coast" }, { "id": 34, "title": "Hobart" }, { "id": 31, "title": "Melbourne" }, { "id": 32, "title": "Perth" }, { "id": 94, "title": "Sydney" } ], "flag": "https://flagcdn.com/28x21/au.png", "phone_code": "61" }, { "id": 39, "title": "Canada", "cities": [ { "id": 21, "title": "CALGARY" }, { "id": 23, "title": "MISSISSAUGA" }, { "id": 11, "title": "MONTREAL" }, { "id": 20, "title": "OTTAWA" }, { "id": 3, "title": "TORONTO" }, { "id": 4, "title": "VANCOUVER" }, { "id": 19, "title": "VICTORIA" }, { "id": 22, "title": "WINNIPEG" } ], "flag": "https://flagcdn.com/28x21/ca.png", "phone_code": "1" } ] }}Students
Register new Student
This API is used to create a student and apply for him for a given program.
POST
https://otas.oktamam.info/api/v1/students
Request Headers
Content-Type: multipart/form-data
Request body
| KEY | VALUE | DESCRIPTION |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| user.name@domain.com | Required Student email for sending status emails and checking application statuses |
|
| password | 123456 | Required Password for the student, please add fixed as 123456 |
| password_confirmation | 123456 | Required Confirmation for the password, please add fixed as 123456 |
| name | Name | Required First name of the student |
| surname | Surname | Required Surname of the student |
| nationality | 221 | Required Country ID for the student nationality, you can get it from settings country |
| visa_country | 221 | Required Country ID that the student need the visa from, get the id from the country list in settings API |
| is_transfer | 0 | Required Integer value (0 or 1) to tell if student is transferring from another university or not |
| has_blue_card | 0 | Required Integer value (0 or 1) to tell if student has blue card or not |
| has_tc_number | 0 | Required Integer value (0 or 1) to tell if student has tc number or not |
| tc_number | 12345678901 | Conditional required if has_tc is 1, optional if 0, 11 number |
| passport_no | P123456789 | Required Passport number |
| passport_issue_date | 10-10-2020 | Required Passport issue date, format 'dd-mm-yyyy' |
| passport_expiry_date | 10-10-2030 | Required Passport expire date, format 'dd-mm-yyyy' |
| phone | 123466789 | Required Student phone number |
| country_code | 221 | Required Student phone country ID |
| birthdate | 10-10-2006 | Required Student birthdate, format 'dd-mm-yyyy' |
| gender | male | Required Student gender (male, female) |
| marital | Single | Required Student marital status (Single,Married) |
| residence_country | 36 | Required Country ID for the student country of residence, you can get it from settings country |
| father_name | Baba | Required Student father name |
| father_number | 123456 | Optional Student father number |
| mother_name | Anne | Required Student mother name |
| address_aboard | Address aboard | Optional student address outside Turkey |
| address_inside | Turkey | Optional student address inside Turkey |
| year_id | 4 | Required Year ID which student would like to apply in, you can get it from Get Program years |
| semester_id | 1 | Required Semester which student would like to apply in, you can get it from Get Program years |
| level_id | 1 | Required Level ID which student want to apply in, you can find it in settings API |
| program_id | 1202 | Required Program ID student would like to apply in, you can get it in programs list |
| high_school_name | High school name | Conditional Name of high school, required if student is applying to a Bachelor or Associate program |
| high_school_country | 221 | Conditional Country ID of high school, required if student is applying to a Bachelor or Associate program |
| high_school_gba | 99 | Optional GPA of high school |
| bachelor_university_name | Bachelor university name | Conditional Name of bachelor university, required if student is applying to a Master or PhD program |
| bachelor_university_country | 221 | Conditional Country ID of bachelor university, required if student is applying to a Master or PhD program |
| bachelor_university_gba | 99 | Optional GPA of bachelor |
| master_university_name | Master university name | Conditional Name of master university, required if student is applying to a PhD program |
| master_university_country | 221 | Conditional Country ID of master university, required if student is applying to a PhD program |
| master_university_gba | 11 | Optional GPA of master |
| passport | Required Scan of Passport, accepts multi files |
|
| diploma | Required Scan of Diploma, accepts multi file. |
|
| transcript | Required Scan of Transcript, accepts multi files |
|
| blue_card | Conditional Scan of Blue Card, required if has_blue_card is 1, optional if 0, accepts multi files |
|
| tc | Conditional Scan of TC Kimlik, required if has_tc is 1, optional if 0, accepts multi files |
|
| photo | Required Student personal photo |
|
| course_description | Conditional Scan of Course Description, required if is_transfer is 1, optional if 0, accepts multi files |
|
| skills | Optional Scan of English Skills Certificates, accepts multi files |
|
| ml | Optional Scan of Motivation Letter, accepts multi files |
|
| rl | Optional Scan of Recommendation Letter, accepts multi files |
|
| other | Optional Scan of Other files, accepts multi files |
|
| sid | 87654567 | Optional to send student sid |
Apply
Create an application for existing student.
POST
https://otas.oktamam.info/api/v1/apply
Body form-data
| KEY | VALUE | DESCRIPTION |
|---|---|---|
| api_key | [api-key-here] | Required API key |
| year_id | 9 | Required Academic year for the application |
| program_id | 488 | Required The program Id |
| create_auto_apps | 1 | Required Boolean value (0 or 1) to create auto applications for student in same program, same semester and year. |
| student_id | 39504 | Required Student Id retrieved from /checker endpoint. |