Profdir's API allows our business clients to manage part of their activities automatically, that is without human intervention.
Business users can via the API post new jobs, edit, archive, reactivate and delete job ads and download details of those users that have applied to their vacancies.
The above actions can be performed via HTTPS requests to the endpoints along with the parameters required and documented in this guide. An endpoint is a URL address that accepts API requests.
Access to the API is available to all business accounts for testing, however, requests are only actually executed on Standard and Premium accounts. It is therefore possible to debug the API integration in free mode and then switch to other modes when the interface is fully develop and the client is ready to deploy it.
Every business account is provided with a unique token that identifies the user, this token must be provided in every API request.
If you are logged in while reading this article your unique token will appear below. Please, make sure you dont share it as this gives access to your account without using your login and password combination.
Your token is: you are not logged in
This token is submitted to the endpoints via an authentication Bearer header for every request.
The endpoint response is provided in JSON format.
As the most basic example you can submit a request via the curl command to check your account mode and remmaining credits:
This API documentation will guide you implementing the API interface as it describes the different types of requests that you can perform the endpoints and then parameters to be sent via POST. Use the menu to navigate through all endpoints and their funcionalities.
account mode and credits
Retrieve your account mode and credits available.
No parameters required.
Posting new jobs and editing existing ones can be executed via the same endpoint>
To publish a new job you will omit the parameter "id".
- salary, optional, salario, a number.
- sectors, optional, betweeen 1 and 3 sectores. Check códigos. If the API is unable to automatically identify the professional sector then this field becomes mandatory.
- jobtitle, required, job title, up to 255 characters.
- experience, required, years of experience between 1 and 20.
- city, required city where the job is located, characters string.
- area, optional, state or county. Check codes codes. If the API is unable to automatically identify the professional sector then this field becomes mandatory.
- email, required, email where to receive notifications.
- contract, required, type of contract see codes.
- description, required, detailed description of the job vacancy, character string.
When receiving the request the endpoint will return a message confirming whether it was successful, errors and additional information. This response is provided in JSON format.
This is an example of a request made with no paramaters.
A successful request will yield the following response:
list of published and archived jobs
Access to the list of your pubished or archived jobs.
https://pt.profdir.com/api/business/active-jobs , your live jobs.
https://pt.profdir.com/api/business/archived-jobs , your archived jobs.
No parameters are required.
activate, archive or delete jobs
Activate, archive or remove a job ad.
- id, required, identifies the ad.
- status, required, values: A -activate- ,D -archive- ,X -remove-.
List of applications received in response to an ad identified by its id.
- id, required, uniquely identifies a job ad.
view applicationAccess details for a user that has applied to one of your vacancies.
In order to obtain the endpoint for each applicant you can first make a request to the applications list first for each job id. This will return the unique url to access each applicant, as well as other details.