API SandBox
Step 1: Generate Token
Give you Client ID and Client Secret that you generated when purchasing the IYS API or enter the Trial Client ID and Client Secret Click here to get your free Trial
Send the Client Id and Client Secret along with the
grant_type
parameter as client_credentials
to https://skills.itsyourskills.com/oauth/token
EXPONENT DEFINITION
https://skills.itsyourskills.com/oauth/token
REQUEST EXAMPLE
curl -X POST --include 'https://skills.itsyourskills.com/oauth/token' \ -d 'client_id=' \ -d 'client_secret=' \ -d 'grant_type=client_credentials'
// These code snippets use an open-source library. http://unirest.io/java HttpResponseresponse = Unirest.post("https://skills.itsyourskills.com/oauth/token") .header("Content-Type", "application/x-www-form-urlencoded") .field("client_id", "") .field("client_secret", "") .field("grant_type", "client_credentials") .asJson();
// These code snippets use an open-source library. http://unirest.io/nodejs unirest.post("https://skills.itsyourskills.com/oauth/token") .header("Content-Type", "application/x-www-form-urlencoded") .send("client_id=") .send("client_secret=") .send("grant_type=client_credentials") .end(function (result) { console.log(result.status, result.headers, result.body); });
// These code snippets use an open-source library. http://unirest.io/php $response = Unirest\Request::post("https://skills.itsyourskills.com/oauth/token", array( "Content-Type" => "application/x-www-form-urlencoded" ), array( "client_id" => "", "client_secret" => "", "grant_type" => "client_credentials" ) );
# These code snippets use an open-source library. http://unirest.io/python response = unirest.post("https://skills.itsyourskills.com/oauth/token", headers={ "Content-Type": "application/x-www-form-urlencoded" }, params={ "client_id": "", "client_secret": "", "grant_type": "client_credentials" } )
// These code snippets use an open-source library. http://unirest.io/objective-c NSDictionary *headers = @{@"Content-Type": @"application/x-www-form-urlencoded"}; NSDictionary *parameters = @{@"client_id": @"", @"client_secret": @"", @"grant_type": @"client_credentials"}; UNIUrlConnection *asyncConnection = [[UNIRest post:^(UNISimpleRequest *request) { [request setUrl:@"https://skills.itsyourskills.com/oauth/token"]; [request setHeaders:headers]; [request setParameters:parameters]; }] asJsonAsync:^(UNIHTTPJsonResponse *response, NSError *error) { NSInteger code = response.code; NSDictionary *responseHeaders = response.headers; UNIJsonNode *body = response.body; NSData *rawBody = response.rawBody; }];
/# These code snippets use an open-source library. http://unirest.io/ruby response = Unirest.post "https://skills.itsyourskills.com/oauth/token", headers:{ "Content-Type" => "application/x-www-form-urlencoded" }, parameters:{ "client_id" => "", "client_secret" => "", "grant_type" => "client_credentials" }
// These code snippets use an open-source library. http://unirest.io/net Task> response = Unirest.post("https://skills.itsyourskills.com/oauth/token") .header("Content-Type", "application/x-www-form-urlencoded") .field("client_id", "") .field("client_secret", "") .field("grant_type", "client_credentials") .asJson();
Step 2: Skills Search
From this point on, all your API requests are sent with an
Authorization
header. Add the Authorization field to your Request header and give your access_token
as Authorization value with the prefix Bearer
. Paste your access_token
obtained from Step 1 with the Bearer
prefix in the Authorization field below like Bearer //your access token//
Here, you can search for a skill name and all the skills with that search term are returned as a JSON response. Now send your search query in
q
parameter to https://skills.itsyourskills.com/api/skill-search
The
l
parameter limits the number of results. leaving it blank will fetch all results
The
o
parameter offsets the number of results before limiting incase you need results from 11 to 30, you give the offset as 10 and limit as 20
The
skill_type
parameter fetches only the type of skill metioned. 0
for functional skills and 1
for behavioral skills
EXPONENT DEFINITION
https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=
REQUEST EXAMPLE
curl --get --include 'https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=' \ -H 'Accept: application/json', -H 'Authorization: '
// These code snippets use an open-source library. http://unirest.io/java HttpResponseresponse = Unirest.get("https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=") .header("Accept", "application/json"), .header("Authorization", "") .asJson();
// These code snippets use an open-source library. http://unirest.io/nodejs unirest.get("https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=") .header("Accept", "application/json"), .header("Authorization", "") .end(function (result) { console.log(result.status, result.headers, result.body); });
// These code snippets use an open-source library. http://unirest.io/php $response = Unirest\Request::get("https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=", array( "Accept" => "application/json", "Authorization": "" ) );
# These code snippets use an open-source library. http://unirest.io/python response = unirest.get("https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=", headers={ "Accept": "application/json", "Authorization": "" } )
// These code snippets use an open-source library. http://unirest.io/objective-c NSDictionary *headers = @{@"Accept": @"application/json", @"Authorizarion": @""}; UNIUrlConnection *asyncConnection = [[UNIRest get:^(UNISimpleRequest *request) { [request setUrl:@"https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type="]; [request setHeaders:headers]; }] asJsonAsync:^(UNIHTTPJsonResponse *response, NSError *error) { NSInteger code = response.code; NSDictionary *responseHeaders = response.headers; UNIJsonNode *body = response.body; NSData *rawBody = response.rawBody; }];
# These code snippets use an open-source library. http://unirest.io/ruby response = Unirest.get "https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=", headers:{ "Accept" => "application/json", "Authorization" => "" }
// These code snippets use an open-source library. http://unirest.io/net Task> response = Unirest.get("https://skills.itsyourskills.com/api/skill-search?q=&l=&o=&skill_type=") .header("Accept", "application/json") .header("Authorization", "") .asJson();
Step3 : Related skills Search
Now, in order to get all the related skills to a particular skill/role, you need to pass the
id
of the skill acquired from Step 2 in the id parameter and send it to https://skills.itsyourskills.com/api/related-skill-search
. Note that passing an id of a skill which has the is_role
property set to 1 will return another set of skills that are assigned to that role and you will have to pass an id from that list to get related skills
EXPONENT DEFINITION
https://skills.itsyourskills.com/api/related-skill-search?id=
REQUEST EXAMPLE
curl --get --include 'https://skills.itsyourskills.com/api/related-skill-search?id=' \ -H 'Accept: application/json' -H 'Authorization: '
// These code snippets use an open-source library. http://unirest.io/java HttpResponseresponse = Unirest.get("https://skills.itsyourskills.com/api/related-skill-search?id=") .header("Accept", "application/json") .header("Authorization", "") .asJson();
// These code snippets use an open-source library. http://unirest.io/nodejs unirest.get("https://skills.itsyourskills.com/api/related-skill-search?id=") .header("Accept", "application/json") .header("Authorization", "") .end(function (result) { console.log(result.status, result.headers, result.body); });
/// These code snippets use an open-source library. http://unirest.io/php $response = Unirest\Request::get("https://skills.itsyourskills.com/api/related-skill-search?id=", array( "Accept" => "application/json" "Authorization" => "" ) );
# These code snippets use an open-source library. http://unirest.io/python response = unirest.get("https://skills.itsyourskills.com/api/related-skill-search?id=", headers={ "Accept": "application/json" "Authorization": "" } )
// These code snippets use an open-source library. http://unirest.io/objective-c NSDictionary *headers = @{@"Accept": @"application/json", @"Authorization": @""}; UNIUrlConnection *asyncConnection = [[UNIRest get:^(UNISimpleRequest *request) { [request setUrl:@"https://skills.itsyourskills.com/api/related-skill-search?id="]; [request setHeaders:headers]; }] asJsonAsync:^(UNIHTTPJsonResponse *response, NSError *error) { NSInteger code = response.code; NSDictionary *responseHeaders = response.headers; UNIJsonNode *body = response.body; NSData *rawBody = response.rawBody; }];
# These code snippets use an open-source library. http://unirest.io/ruby response = Unirest.get "https://skills.itsyourskills.com/api/related-skill-search?id=", headers:{ "Accept" => "application/json" "Authorization" => "" }
// These code snippets use an open-source library. http://unirest.io/net Task> response = Unirest.get("https://skills.itsyourskills.com/api/related-skill-search?id=") .header("Accept", "application/json") .header("Authorization", "") .asJson();
Step 4 : Category Skills Search
You can also search for skills under a category by passing the category id you obtained from Step 2. Pass the category id to the id parameter and send a request to
https://skills.itsyourskills.com/api/category-search
EXPONENT DEFINITION
https://skills.itsyourskills.com/api/category-search?id=
REQUEST EXAMPLE
curl --get --include 'https://skills.itsyourskills.com/api/category-search?id=' \ -H 'Accept: application/json' -H 'Authorization: '
// These code snippets use an open-source library. http://unirest.io/java HttpResponseresponse = Unirest.get("https://skills.itsyourskills.com/api/category-search?id=") .header("Accept", "application/json") .header("Authorization", ".header("Authorization", "")") .asJson();
// These code snippets use an open-source library. http://unirest.io/nodejs unirest.get("https://skills.itsyourskills.com/api/category-search?id=") .header("Accept", "application/json") .header("Authorization", "") .end(function (result) { console.log(result.status, result.headers, result.body); });
// These code snippets use an open-source library. http://unirest.io/php $response = Unirest\Request::get("https://skills.itsyourskills.com/api/category-search?id=", array( "Accept" => "application/json" "Authorization": "" ) );
# These code snippets use an open-source library. http://unirest.io/python response = unirest.get("https://skills.itsyourskills.com/api/category-search?id=", headers={ "Accept": "application/json" "Authorization": "" } )
// These code snippets use an open-source library. http://unirest.io/objective-c NSDictionary *headers = @{@"Accept": @"application/json"}; UNIUrlConnection *asyncConnection = [[UNIRest get:^(UNISimpleRequest *request) { [request setUrl:@"https://skills.itsyourskills.com/api/category-search?id="]; [request setHeaders:headers]; }] asJsonAsync:^(UNIHTTPJsonResponse *response, NSError *error) { NSInteger code = response.code; NSDictionary *responseHeaders = response.headers; UNIJsonNode *body = response.body; NSData *rawBody = response.rawBody; }];
# These code snippets use an open-source library. http://unirest.io/ruby response = Unirest.get "https://skills.itsyourskills/api/category-search?id=", headers:{ "Accept" => "application/json" "Authorization" => " }
// These code snippets use an open-source library. http://unirest.io/net Task> response = Unirest.get("https://skills.itsyourskills.com/api/category-search?id=") .header("Accept", "application/json") .header("Authorization", "") .asJson();