PHP SDK
HrFlow.ai PHP installation guide.
Our PHP library is an open source, production-ready and a PHP Wrapper API. It is an easy way to access HrFlow API features .
This library is open-source, so you can check it out on GitHub.

Install

Install the package via Composer:
1
composer require hrflow/hrflow-php-api
Copied!

Without Composer

1) Clone the repository from GitHub.
1
git clone https://github.com/Riminder/php-hrflow-api.git /folder/path
Copied!
2) Then you must add the following code to your PHP script to actually load the HrFlow:
1
require_once("/path/to/php-hrflow-api/init.php");
Copied!
You can keep the API client up to date by checking GitHub release page.

Initialize the client

To authenticate against the API, get your API SECRET KEY from your HrFlow dashboard!
To begin you adventure with HrFlow, you will need to initialize the client. In order to do this you will need your API SECRET KEY. You can retrieve it from HrFlow Dashboard
1
require __DIR__ . '/vendor/autoload.php';
2
3
// Authentication to api
4
$client = new Hrflow\Client('your api key');
Copied!

Methods

Profile

List of Methods
You can upload either json or binary (file) Profile
Profile search engine
Retrieve Profile's scoring
Retrieve Profile's indexing JSON
Retrieve Profile's parsing
Retrieve Profile's embedding
Retrieve Profile's revealing
Retrieve Profile's reasoning

Job

List of methods
Uploading a job by specifying some information.
Retrieve Job's indexing JSON
Retrieve Job's parsing
Retrieve Job's embedding for advanced analysis
Job search engine
Retrieve scoring for list of jobs
Retrieve Job's reasoning

Source

List of methods
Method used for finding list of sources by the given condition
Retrieve source's information for a given source_id

Webhook

List of methods
Send a webhook notification test
Last modified 7mo ago