StepByCV API

API Kullanım

Recruiter CV Analysis API - Job Match Scoring endpoint dokümantasyonu

Authentication

API istekleri için önce Bearer token almanız gerekir. ConsumerKey ve SecretKey ile token endpoint'ine istek atarak token alın, sonra diğer endpoint'lerde bu token'ı Authorization: Bearer header'ında gönderin.

1. Token Al

POST https://api.stepbycv.com/api/recruiter/v1/token
Content-Type: application/json

{
  "consumerKey": "sbcr_xxxxxxxxxxxxxxxxxxxxxxxx",
  "secretKey": "your-secret-key"
}

Response: { "accessToken": "...", "expiresIn": 3600 } (expiresIn saniye cinsinden, varsayılan 1 saat)

2. API İsteklerinde Token Kullan

Authorization: Bearer {accessToken}

Endpoint

POST https://api.stepbycv.com/api/recruiter/v1/analyze-cv

Request (multipart/form-data)

AlanTipZorunluAçıklama
filePDFEvetCV dosyası
roleIdGuidHayır*Varsayılan rol (jobDescription yoksa zorunlu)
jobDescriptionstringHayırİş ilanı metni; varsa analiz buna göre yapılır
jobTitlestringHayırİş ilanı başlığı (opsiyonel)

* roleId veya jobDescription en az biri zorunludur.

Response (200 OK)

{
  "score": 82,
  "matchLevel": "High",
  "missingSkills": ["Docker", "Kubernetes"],
  "strongSkills": ["C#", ".NET", "SQL"],
  "experienceMatch": true,
  "summary": "Candidate is strong backend developer..."
}

matchLevel: High (≥75), Medium (≥50), Low (<50)

cURL Örneği

Önce token alın:

# 1. Token al
TOKEN=$(curl -s -X POST "https://api.stepbycv.com/api/recruiter/v1/token" \
  -H "Content-Type: application/json" \
  -d '{"consumerKey":"sbcr_your_consumer_key","secretKey":"your_secret_key"}' \
  | jq -r '.accessToken')

# 2. analyze-cv ile istek at
curl -X POST "https://api.stepbycv.com/api/recruiter/v1/analyze-cv" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@cv.pdf" \
  -F "jobDescription=We are looking for a .NET Developer with 3+ years experience in C#, SQL, and REST APIs..."

jq yoksa, token response'undan accessToken değerini manuel kopyalayıp Bearer header'ında kullanabilirsiniz.