API Authentication and Usage

Introduction

This API endpoint allow you to verify your API Key and retrieve your current usage levels of the PerformYard API.

Requirements

Calling this API endpoint requires an API Key and API ID. See Getting Started with PerformYard API for details on creating API keys.

Authentication Headers

Once you have created your API Key within the PerformYard Authentication settings, you must include the API Key and API ID values in every PerformYard API request.  These are sent using two HTTP Headers: x-api-id and x-api-key.

x-api-id
The unique identifier for each user or client making a request.
x-api-key
This secret key is associated with the x-api-id.

Verifying Your API Key and Retrieving Usage Details

GET https://api.talent.performyard.com/v1/auth/verify

Allows you to verify that the API ID and key generated in Getting Started with PerformYard API are valid while also providing information about your API usage.

CURL Example

curl --location -X GET "https://api.talent.performyard.com/v1/auth/verify" \
--header 'Accept: application/json' \
--header 'x-api-id: {{X-API-ID}}' \
--header 'x-api-key: {{X-API-KEY}}'

Response (200)

{
    "company_name": "<string>",
    "last_used": "<datetime>",
    "is_enabled": true,
    "quota_limit": 10000,
    "requests_made": 0,
    "refresh_period": "<string>"
}

Related Articles