Skills Intelligence Engine API Code Samples

Selection of code samples that demonstrate the use of the Skills Intelligence Engine API. Copy and edit these code samples to suit your needs.

When using the code samples, remember to replace:

{vanity_name} with your tenant name
{api_key} with your API key

These code samples may not include all available parameters and request body fields for each endpoint. For the endpoint's full request schema, see "Skills Intelligence Engine" in API Reference.

Standardize job titles

Use these sample requests to return the top matching standardized jobs for a given custom job title.

POST v1/jobs/standardize

Single job title

This sample request finds the standardized jobs for the custom job title sw dev.

Copy

cURL sample request: Standardize single job title

1
2
3
4
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1/jobs/standardize' \
-H 'apikey: {api_key}' \
-H 'Content-Type: application/json' \
--data '{"jobs": ["sw dev"]}'

The response returns the standardized jobs for the custom job title.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[
    {
        "job": "sw dev",
        "matches": [
            {
                "id": "5746",
                "name": "software developer",
                "description": "People in this job implement or program all kinds of software systems based on specifications and designs by using programming languages, tools and platforms.",
                "score": 72
            },
            {
                "id": "5281",
                "name": "web developer",
                "description": "People in this job develop, implement and document web-accessible software based on the designs provided. They align the client's web presence with its business strategy, troubleshoot software problems and issues and look for ways to improve the application.",
                "score": 64
            },
            {
                "id": "5197",
                "name": "ICT application developer",
                "description": "People in this job implement the ICT (software) applications based on the designs provided using application domain specific languages, tools, platforms and experience.",
                "score": 57
            },
            {
                "id": "4946",
                "name": "ICT system developer",
                "description": "People in this job maintain, audit and improve organisational support systems. They use existing or new technologies to meet particular needs. They test both hardware and software system components, diagnose and resolve system faults.",
                "score": 54
            },
            {
                "id": "5050",
                "name": "database developer",
                "description": "People in this job program, implement and coordinate changes to computer databases based on their expertise of database management systems.",
                "score": 54
            }
        ]
    }
]

Multiple job titles

This sample request finds the standardized jobs for the custom job titles sw dev and qa engineer. You can include a maximum of 10 custom job titles in each request.

Copy

cURL sample request: Standardize multiple job titles

1
2
3
4
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1/jobs/standardize' \
-H 'apikey: {api_key}' \
-H 'Content-Type: application/json' \
--data '{"jobs": ["sw dev", "qa engineer"]}'

The response includes a set of matches for each job title.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
[
    {
        "job": "sw dev",
        "matches": [
            {
                "id": "5746",
                "name": "software developer",
                "description": "People in this job implement or program all kinds of software systems based on specifications and designs by using programming languages, tools and platforms.",
                "score": 72
            },
            {
                "id": "5281",
                "name": "web developer",
                "description": "People in this job develop, implement and document web-accessible software based on the designs provided. They align the client's web presence with its business strategy, troubleshoot software problems and issues and look for ways to improve the application.",
                "score": 64
            },
            {
                "id": "5197",
                "name": "ICT application developer",
                "description": "People in this job implement the ICT (software) applications based on the designs provided using application domain specific languages, tools, platforms and experience.",
                "score": 57
            },
            {
                "id": "4946",
                "name": "ICT system developer",
                "description": "People in this job maintain, audit and improve organisational support systems. They use existing or new technologies to meet particular needs. They test both hardware and software system components, diagnose and resolve system faults.",
                "score": 54
            },
            {
                "id": "5050",
                "name": "database developer",
                "description": "People in this job program, implement and coordinate changes to computer databases based on their expertise of database management systems.",
                "score": 54
            }
        ]
    },
    {
        "job": "qa engineer",
        "matches": [
            {
                "id": "3546",
                "name": "quality engineer",
                "description": "People in this job define quality standards for the creation of products or services. They check to make sure the products and services are in compliance with the quality standards and they coordinate quality improvements.",
                "score": 87
            },
            {
                "id": "4793",
                "name": "quality engineering technician",
                "description": "People in this job work with quality engineers or managers to analyse and solve quality problems and improve productivity. They examine machines for imperfections and inspect products to make sure they meet the standards. They also provide personnel with training in inspection techniques and prepare inspection plans.",
                "score": 70
            },
            {
                "id": "3817",
                "name": "gambling quality assurance engineer",
                "description": "People in this job design and plan methods to test the gambling, the lottery or betting games. They execute the tests. These games can be both for public or for private audience, and the tests are for both online and land-based gaming.",
                "score": 68
            },
            {
                "id": "5338",
                "name": "test engineer",
                "description": "People in this job plan and perform detailed quality tests during various phases of the design process to make sure that the systems are properly installed and function correctly. They analyse the data collected during tests and produce reports. They are also responsible for the safety of the test operations.",
                "score": 64
            },
            {
                "id": "4300",
                "name": "data quality specialist",
                "description": "People in this job review organisation's data for accuracy, recommend enhancements to record systems and data acquisition processes and assess referential and historical integrity of data. They also develop documents and maintain data quality goals and standards and oversee an organisation's data privacy policy and monitor compliance of data flows against data quality standards.",
                "score": 63
            }
        ]
    }
]

Browse jobs

Use these sample requests to see a list of all jobs and then retrieve the details of a specific job.

GET v1/jobs

All jobs

In this sample request, we retrieve a list of all jobs.

Copy

cURL sample request: List all jobs

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/jobs' \
-H 'apikey: {api_key}'

Jobs are returned as a list of entries. Basic identification information is included with each entry.

View sample response

Copy

1
2
3
4
5
6
7
8
9
[
    ...,
    {
        "id": "5746",
        "name": "software developer",
        "description": "People in this job implement or program all kinds of software systems based on specifications and designs by using programming languages, tools and platforms."
    },
    ...
]

Job details

After, you identify an job of interest, use the following sample request to retrieve additional information about the job such as alternative job titles and associated skills. In this request, we're retrieving details for the job with the ID 5746, which corresponds to software developer.

Copy

cURL sample request: Get details of a specific job

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/jobs/5746' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "id": "5746",
  "name": "software developer",
  "description": "People in this job implement or program all kinds of software systems based on specifications and designs by using programming languages, tools and platforms.",
  "automationIndex": 42,
  "remoteIndex": 100,
  "alternativeTitles": [
    "programmer",
    "software developers",
    "software specialist",
    "application software developer",
    "application programmer"
  ],
  "essentialSkills": [...]
  "optionalSkills": [...]
}

Browse skills

Use these sample requests to see a list of all skills and then retrieve the details of a specific skill.

GET v1/skills

All skills

In this sample request, we retrieve a list of all skills.

Copy

cURL sample request: List all skills

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skills' \
-H 'apikey: {api_key}'

Skills are returned as a list of entries. Basic identification information is included with each entry.

View sample response

Copy

1
2
3
4
5
6
7
8
9
[
    ...,
   {
        "id": "21155",
        "name": "software design methodologies",
        "description": "The methodologies such as Scrum, V-model and Waterfall to design software systems and applications."
    },
    ...
]

Skill details

After, you identify a skill of interest, use the following sample request to retrieve additional information about the skill. In this request, we're retrieving details for the skill with the ID 21155, which corresponds to software design methodologies.

Copy

cURL sample request: Get details of a specific skill

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skills/21155' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
6
7
8
{
    "id": "21155",
    "name": "software design methodologies",
    "description": "The methodologies such as Scrum, V-model and Waterfall to design software systems and applications.",
    "skillGroupId": "24",
    "skillCategoryId": "6",
    "alternativeTitles": []
}

Skills hierarchy

You can navigate the skills hierarchy to explore related skills or narrow down the skills that are relevant to your area of interest. Skills are organized into categories, groups, and then individual skills.

This sample request retrieves a list of skill categories:

Copy

Curl sample request: Get skill categories

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skill-categories' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
6
7
8
[
    ...
    {
        "id": "6",
        "name": "Computer science and mathematics: software, programming languages, security, etc."
    },
    ...
]

This sample request retrieves a list of skill groups:

Copy

cURL sample request: Get skill groups

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skill-groups' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
6
7
8
[
    ...
    {
        "id": "12",
        "name": "Computer programming and software languages"
    },
    ...
]

The details and the child skill groups of each skill category can be retrieved by ID.

This sample request retrieves the skill groups of the skill category with the ID 6, which corresponds to Computer science and mathematics: software, programming languages, security, etc.

Copy

cURL sample request: Get skill groups by skill category ID.

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skill-categories/6' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
{
    "id": "6",
    "name": "Computer science and mathematics: software, programming languages, security, etc.",
    "skillGroups": [...]
}

The details and the child skills of each skill group can be retrieved by ID.

This sample request retrieves the skills of the skill group with the id 12, which corresponds to Computer programming and software languages.

Copy

cURL sample request: Get skills by skill group ID.

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skill-groups/12' \
-H 'apikey: {api_key}'

View sample response

Copy

1
2
3
4
5
6
{
    "id": "12",
    "name": "Computer programming and software languages",
    "skillCategoryId": "6",
    "skills":  [...]
}

When browsing through skills, you can add query parameters to filter the list of skills by a specific skill category and/or skill group. This sample request retrieves skills that are in skill category 6 and skill group 12.

Copy

cURL sample request: Get skills by skill group ID.

1
2
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/skills?skillCategoryId=6&skillGroupId=12' \
-H 'apikey: {api_key}'

You will get a list of skills from a specific part of the hierarchy.

View sample response

Copy

1
2
3
4
5
6
7
8
9
[
    ...
    {
        "id": "23113",
        "name": "C++",
        "description": "The techniques and principles of software development, such as analysis, algorithms, coding, testing and compiling of programming paradigms in C++."
    },
    ...
]