Getting Started

CEPA Test’s API allows to create an access code, just as the CEPA Test’s system does. The web service is based on REST and is available in XML.

Here are just a few quick tips to get you started:

Integration Tips

In order to access the CEPA Test's API, you need to register a developer account on this website. This will register you on our API gateway and create an access to test the API with a small quota. When you are ready to go to production and need a bigger quota, feel free to contact us.

Authentication

You can find your Ticket ID on your dashboard. To make queries, you will have Ticket ID to connect services as it below:

sample_ticket_id

Methods

You can generate an access code with the method below:
Create Access Code
Method
CreateTokenByTicket
Parameter Data Type Description
ticket string Given ticket ID
companyID int Candidate's company
testID int CEPA Tests IDs
firstName string Candidate's name
lastName string Candidate's last name
eMail string Candidate's e-mail
appID int your App ID given by system
Results
Parameter Result
Token The access code to access the test
Company List
Method
GetCompaniesByTicket
Parameter Data Type Description
ticket string Given ticket ID
Results
Parameter Result
CompanyId Company ID
CompanyName Company Name
List Tests by e-Mail
Method
GetTestsByMail
Parameter Data Type Description
ticket string Given ticket ID
mail string Candidate's e-mai address
Results
Parameter Data Type Description
ID int Record ID
TokenId string Test name
Userid int Candidate's user profile ID
Companyid int Candidate's company Id
Testid int Test ID
TestName string Test Name
Firstname string First Name
Lastname string Last Name
Mail string E-mail
Phone string Phone
Gender int Gender
Completed int Complete status for tests (except Listening)
Completed2 int Listening test complete status
CompletedDate string Completed date for tests (except Listening)
CompletedDate2 string Listening complete date
Userphoto string Candidate's photo
Date dateTime Access code create date
Scale int Scale Id
Score1 decimal Test Score (except Listening)
Score1Description string Test CEFR Description (except Listening)
Score1Cefr string Test CEFR Level (except Listening)
Score2 decimal Listening Score
Score2Description string Listening CEFR Description
Score2Cefr string Listening CEFR Level
Overall decimal Tests Overall Score
OverallDescription string Tests CEFR Description
OverallCefr string Tests Listening CEFR Level
List Tests by User Id
Method
GetTokensById
Parameter Data Type Description
ticket string Given ticket ID
userIdNumber int Candidate's User ID
Results
Parameter Data Type Description
ID int Record ID
TokenId string Test name
Userid int Candidate's user profile ID
Companyid int Candidate's company Id
Testid int Test ID
TestName string Test Name
Firstname string First Name
Lastname string Last Name
Mail string E-mail
Phone string Phone
Gender int Gender
Completed int Complete status for tests (except Listening)
Completed2 int Listening test complete status
CompletedDate string Completed date for tests (except Listening)
CompletedDate2 string Listening complete date
Userphoto string Candidate's photo
Date dateTime Access code create date
Scale int Scale Id
Score1 decimal Test Score (except Listening)
Score1Description string Test CEFR Description (except Listening)
Score1Cefr string Test CEFR Level (except Listening)
Score2 decimal Listening Score
Score2Description string Listening CEFR Description
Score2Cefr string Listening CEFR Level
Overall decimal Tests Overall Score
OverallDescription string Tests CEFR Description
OverallCefr string Tests Listening CEFR Level
Tests
Method
GetTests
Results
Parameter Result
id Test ID
Exam Test name