API Documentation: ScoreResume
Welcome to the ScoreMyResume API documentation page. Here, you will find all the necessary information to integrate our API into your applications seamlessly. The ScoreMyResume API allows you to analyze resumes and provide scores based on various criteria.
https://play.scoremyresume.com/api/score/analyze
Authentication:
To access the API, you need to include an Authorization header with a valid bearer token. Replace <Token> with your actual bearer token.
There are two methods:
Method 1:
Request Parameters:
description: A string describing the skills or qualifications you want to analyze in the resume.
file: The resume file to be analyzed. Make sure to include the file in the form-data body of your request.
Sample cURL Request:
curl --location 'https://play.scoremyresume.com/api/score/analyze' \
--header 'Authorization: Bearer <Token>' \
--form 'description="react nodejs angular"' \
--form 'file=@"<Path>"'
Method 2:
Request Parameters:
description: A string describing the skills or qualifications you want to analyze in the resume.
cvText: The resume text content to be analyzed.
Sample cURL Request:
curl --location 'https://play.scoremyresume.com/api/score/analyze' \
--header 'Authorization: Bearer <Token>' \
--form 'description="react nodejs angular"' \
--form 'cvText="<Resume Text>"' \
Response:
The API will return a JSON response containing the analyzed data and scores for the provided resume.
{
"experienceMatch": <Score>,
"experienceMatchReason": <Text>,
"stability": <Score>,
"stabilityReason": <Text>,
"skills": <Score>,
"skillsReason": <Text>,
"location": <Score>,
"locationReason": <Text>,
"overall": <Score>
}
Note:
Ensure that you have the necessary permissions and access rights to use the ScoreResume API effectively. For any inquiries or assistance, feel free to contact our support team at Support@scoremyresume.com.
Thank you for choosing ScoreMyResume! We look forward to assisting you with your resume analysis needs.