API Authentication and Usage

Introduction

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

Authentication for the REST API

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.

Headers Description
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.

See Getting Started with PerformYard API for details on creating API keys.

Verifying your API Key and Retrieving Usage Details

This API endpoint will allow for you to verify that the API Key and ID are valid and also retrieve details about the current levels of APIusage for your account.

HTTP GET

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

CURL Example

curl --location '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 OK

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

Related Articles