TopCV SRP developer documents
Partner API
Webhook
SRP
Partner API
Webhook
SRP
  • Giới thiệu chung

    • Giới thiệu chung
    • Webhook
    • Triển khai lên môi trường thực
  • Xác thực tài khoản

    • Liên kết tài khoản
    • Hủy liên kết tài khoản

Liên kết tài khoản

Partner API Access Token

SRP sẽ coi việc tương tác qua Partner API tương tự như một user thông thường. Vì thế, để định danh NTD, SRP yêu cầu một token trên header ở mỗi request. Token này được gọi là Partner API Access Token

// Request Header
{
    "Authorization": "Bearer <Partner API Access Token>",
}

Liên kết tài khoản

Bạn phải là Partner để có thể sử dụng các dịch vụ Partner API trên hệ thống SRP

Để sử dụng các dịch vụ trên hệ thống SRP như Partner, liên hệ với đội ngũ phát triển để nhận được Partner-Secret-Key.

Caution

Mã Partner-Secret-Key này đại diện cho một Partner trên hệ thống SRP, vì thế không được tiết lộ ra ngoài.

Khi muốn liên kết với NTD, yêu cầu NTD cung cấp Access-Token, mã này được hệ thống SRP cung cấp cho mỗi NTD để sử dụng các dịch vụ của Partner, gửi yêu cầu kết nối kèm theo token này để thực hiện liên kết

Endpoint

POST /api/connect

Header

Thuộc tínhGiá trị
Secret-KeyPartner-Secret-Key

Body

Thuộc tínhValidation RulesGiá trị
employer_api_keyBắt buộcAccess-Token

Để lấy được employer_api_key bạn truy cập vào Màn hình cài đặt

Truy cập vào hệ thống Tuyển dụng SRP → Cài đặt tài khoản -> Đồng bộ CV (hoặc nếu bạn đã đăng nhập có thể truy cập thẳng thông qua đường dẫn Đồng bộ CV) Imageemployer_api_key chính là giá trị của trường Access Token trong màn hình cài đặt sau khi chọn sử dụng Đồng bộ CV qua ATS đã tích hợp sẵn với TopCV

Response

// status: 200
{
    "status": "success",
    "message": "",
    "data": {
        "access_token": "<Partner API Access Token>"
    }
}

Đây là token để Partner thực hiện các request tiếp theo

Validation Error Response

// status: 422
{
    "status": "fail",
    "message": "API Key của nhà tuyển dụng không được để trống",
    "errors": {
        "employer_api_key": [
            "API Key của nhà tuyển dụng không được để trống"
        ]
    }
}

Logic Error Response

// status: 422
{
    "status": "fail",
    "message": "",
    "errors": ""
}
Next
Hủy liên kết tài khoản