Img
Book a Demo

    Introduction

    The Phenom API is an easy-to-use REST API for developers to interact with Phenom products. It can be used to build applications on top of Phenom products.

    The Phenom API is a Representational State Transfer (REST) API consisting of HTTP endpoints. Authentication is required to use the endpoints.

    Refer to the Getting started page to start using the APIs and Authentication API page for authentication.

    Authentication API

    Copy to Clipboardcopied!
    curl --location 'https://<hostname>/token'  
--header 'Content-Type: application/x-www-form-urlencoded'  
--data-urlencode 'clientId=xxxx-xxxxx'  
 --data-urlencode 'clientSecret=xxxxx-xxxx'

    All APIs use the OAuth 2.0 (OAuth2) protocol for authentication and authorization. To authenticate the API, you must include an API token (generally referred to as a bearer token) in each API call. A bearer token is a string that is used to give the owner of the token access to a resource. The token should be passed as an "Authorization" header using the "Bearer" authentication scheme.

    Create a API token

    To create an API token, follow the steps below:

    1. Contact api-management@phenom.com to register your application.
    2. Login url, clientId and clientSecret will be provided after registration.
    3. All user-generated tokens should be secured.

    Getting started

    Get an authentication token

         Follow the steps in Authentication to get an authentication token.

    Make a request

    Copy to Clipboardcopied!
    curl -H "Authorization: Bearer <your token>" "https://<hostname>/api/v1/jobs-hiring-team/{jobId}"

    After getting the authentication token, you can interact with the API.

    To include a token in an API call, pass the token in header as "Authorization" using the "Bearer" authentication scheme.

    All API calls to Phenom APIs should use HTTPS.

    How to Navigate to Documentation?

    There are two ways to view the documentation:

    • To view the documentation of a specific entity:You are displayed with the list of Entities on the home page, Click on any entity to view the documentation of that particular entity.

      • OR

    • To view the documentation of all entities: Click on 'View Documentation' button on the home page to navigate to the documentation page where you are displayed with the documentation of all the entities at once.