Latest Version on Packagist Total Downloads
Check the details at SharpAPI's Job Positions API page.
- PHP >= 8.1
- Laravel >= 10.48.29
Follow these steps to install and set up the SharpAPI Laravel Job Positions API package.
- Install the package via
composer:
composer require sharpapi/laravel-job-positions-api
-
Register at SharpAPI.com to obtain your API key.
-
Set the API key in your
.envfile:
SHARP_API_KEY=your_api_key_here
- [OPTIONAL] Publish the configuration file:
php artisan vendor:publish --tag=sharpapi-job-positions-api
- Job Position Search: Search for job positions by title or keyword.
- Job Position Details: Get detailed information about specific job positions.
You can inject the JobPositionsApiService class to access the job positions database functionality.
- Search for Job Positions: Use
searchJobPositionsto find job positions by title or keyword. - Get Job Position Details: Use
getJobPositionByIdto get detailed information about a specific job position.
Here is an example of how to use JobPositionsApiService within a Laravel controller:
<?php namespace App\Http\Controllers; use GuzzleHttp\Exception\GuzzleException; use SharpAPI\JobPositionsApi\JobPositionsApiService; class JobPositionsController extends Controller { protected JobPositionsApiService $jobPositionsService; public function __construct(JobPositionsApiService $jobPositionsService) { $this->jobPositionsService = $jobPositionsService; } /** * @throws GuzzleException */ public function searchJobPositions(string $query) { $results = $this->jobPositionsService->searchJobPositions($query); return response()->json($results); } /** * @throws GuzzleException */ public function getJobPositionDetails(string $positionId) { $position = $this->jobPositionsService->getJobPositionById($positionId); return response()->json($position); } }
All requests are managed by Guzzle, so it's helpful to be familiar with Guzzle Exceptions.
Example:
use GuzzleHttp\Exception\ClientException; try { $positions = $this->jobPositionsService->searchJobPositions('developer'); } catch (ClientException $e) { echo $e->getMessage(); }
You can customize the configuration by setting the following environment variables in your .env file:
SHARP_API_KEY=your_api_key_here SHARP_API_BASE_URL=https://sharpapi.com/api/v1
{
"data": {
"id": "18f73cda-db62-454b-aa53-aa26acb196b7",
"name": "Billing Manager",
"slug": "billing-manager",
"related_job_positions": [
{
"id": "445b1023-2c3c-41c4-a986-08d8400e52a5",
"name": "Accounts Receivable Manager",
"slug": "accounts-receivable-manager",
"weight": 9
},
{
"id": "f6749359-de3a-4c32-ac31-75e059197a0f",
"name": "Billing Coordinator",
"slug": "billing-coordinator",
"weight": 8
},
{
"id": "bd8f8374-a717-4474-be41-5582a67b4ff9",
"name": "Billing Supervisor",
"slug": "billing-supervisor",
"weight": 9.5
}
]
}
}For issues or suggestions, please:
Please see CHANGELOG for a detailed list of changes.
- A2Z WEB LTD
- Dawid Makowski
- Enhance your Laravel AI capabilities!
The MIT License (MIT). Please see License File for more information.
Stay updated with news, tutorials, and case studies: