README

The unified API for building rich integrations with multiple Applicant Tracking System platforms.

For more information, please visit https://www.merge.dev/.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/merge-api/merge-ats-php.git"
    }
  ],
  "require": {
    "merge-api/merge-ats-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/MergeATSClient/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: tokenAuth
$config = MergeATSClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MergeATSClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MergeATSClient\Api\AccountDetailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_account_token = 'x_account_token_example'; // string | Token identifying the end user.

try {
    $result = $apiInstance->accountDetailsRetrieve($x_account_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountDetailsApi->accountDetailsRetrieve: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.merge.dev/api/ats/v1

Class	Method	HTTP request
AccountDetailsApi	accountDetailsRetrieve	GET /account-details
AccountTokenApi	accountTokenRetrieve	GET /account-token/{public_token}
ActivitiesApi	activitiesList	GET /activities
ActivitiesApi	activitiesRetrieve	GET /activities/{id}
ApplicationsApi	applicationsChangeStageCreate	POST /applications/{id}/change-stage
ApplicationsApi	applicationsCreate	POST /applications
ApplicationsApi	applicationsList	GET /applications
ApplicationsApi	applicationsMetaPostRetrieve	GET /applications/meta/post
ApplicationsApi	applicationsRetrieve	GET /applications/{id}
AttachmentsApi	attachmentsCreate	POST /attachments
AttachmentsApi	attachmentsList	GET /attachments
AttachmentsApi	attachmentsMetaPostRetrieve	GET /attachments/meta/post
AttachmentsApi	attachmentsRetrieve	GET /attachments/{id}
AvailableActionsApi	availableActionsRetrieve	GET /available-actions
CandidatesApi	candidatesCreate	POST /candidates
CandidatesApi	candidatesIgnoreCreate	POST /candidates/ignore/{model_id}
CandidatesApi	candidatesList	GET /candidates
CandidatesApi	candidatesMetaPostRetrieve	GET /candidates/meta/post
CandidatesApi	candidatesRetrieve	GET /candidates/{id}
DeleteAccountApi	deleteAccountCreate	POST /delete-account
DepartmentsApi	departmentsList	GET /departments
DepartmentsApi	departmentsRetrieve	GET /departments/{id}
EeocsApi	eeocsList	GET /eeocs
EeocsApi	eeocsRetrieve	GET /eeocs/{id}
ForceResyncApi	syncStatusResyncCreate	POST /sync-status/resync
GenerateKeyApi	generateKeyCreate	POST /generate-key
InterviewsApi	interviewsList	GET /interviews
InterviewsApi	interviewsRetrieve	GET /interviews/{id}
IssuesApi	issuesList	GET /issues
IssuesApi	issuesRetrieve	GET /issues/{id}
JobInterviewStagesApi	jobInterviewStagesList	GET /job-interview-stages
JobInterviewStagesApi	jobInterviewStagesRetrieve	GET /job-interview-stages/{id}
JobsApi	jobsList	GET /jobs
JobsApi	jobsRetrieve	GET /jobs/{id}
LinkTokenApi	linkTokenCreate	POST /link-token
LinkedAccountsApi	linkedAccountsList	GET /linked-accounts
OffersApi	offersList	GET /offers
OffersApi	offersRetrieve	GET /offers/{id}
OfficesApi	officesList	GET /offices
OfficesApi	officesRetrieve	GET /offices/{id}
PassthroughApi	passthroughCreate	POST /passthrough
RegenerateKeyApi	regenerateKeyCreate	POST /regenerate-key
RejectReasonsApi	rejectReasonsList	GET /reject-reasons
RejectReasonsApi	rejectReasonsRetrieve	GET /reject-reasons/{id}
ScorecardsApi	scorecardsList	GET /scorecards
ScorecardsApi	scorecardsRetrieve	GET /scorecards/{id}
SelectiveSyncApi	selectiveSyncConfigurationsList	GET /selective-sync/configurations
SelectiveSyncApi	selectiveSyncConfigurationsUpdate	PUT /selective-sync/configurations
SelectiveSyncApi	selectiveSyncMetaList	GET /selective-sync/meta
SyncStatusApi	syncStatusList	GET /sync-status
TagsApi	tagsList	GET /tags
UsersApi	usersList	GET /users
UsersApi	usersRetrieve	GET /users/{id}
WebhookReceiversApi	webhookReceiversCreate	POST /webhook-receivers
WebhookReceiversApi	webhookReceiversList	GET /webhook-receivers

Models

Authorization

tokenAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

hello@merge.dev

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0
- Package version: 1.0.2
Build package: org.openapitools.codegen.languages.PhpClientCodegen

teenhire / merge-ats-php

Maintainers

Details