Download the PHP package werbeagentur_artrevolver/scope-php-sdk without Composer

On this page you can find all versions of the php package werbeagentur_artrevolver/scope-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of werbeagentur_artrevolver/scope-php-sdk

Informations about the package scope-php-sdk

HeyRestApi

PHP client for the Heyrecruit REST API (/api/v2). It handles authentication, token renewal and the job, company, application and appointment endpoints.

Table of Contents

Requirements

Installation

The package is published on Packagist as werbeagentur_artrevolver/scope-php-sdk; the public repository is Heyrecruit/php-sdk. The two names differ on purpose — always require the Packagist name.

Cloning the repository and requiring src/Heyrecruit/HeyRestApi.php directly works as well; the class has no dependencies beyond the two extensions above.

Configuration

HeyRestApi is configured through a single array. All three keys are required — a missing key throws an InvalidArgumentException.

Key Type Meaning
SCOPE_URL string API base URL, e.g. https://app.heyrecruit.de/api/v2. A trailing slash is stripped.
SCOPE_CLIENT_ID int The company_id of the registered REST app.
SCOPE_CLIENT_SECRET string The client secret, prefixed with SCOPE!.

The constructor authenticates immediately, so creating an instance performs one HTTP request.

Token caching is optional and session-based. If a PHP session is active, the access token is cached in $_SESSION['HEY_AUTH'] and reused across requests; the cache is discarded when the API rejects the token. Without an active session every instance authenticates once — the SDK works outside a web request (CLI, cron) but does not cache there.

Usage

Methods

Method Purpose
setFilter(string $queryParams = ''): void Applies a query string to the job filter. Only known keys are taken over.
getJobs(?int $companyId = null): array Active jobs matching the current filter.
getJob(?int $companyId, int $jobId, int $companyLocationId): array A single job at one location.
getCompanyDetail(int $companyId): array Company data by id.
getCompanyDetailBySubDomain(string $subDomain): array Company data by configured subdomain.
apply(array $data): array Submits an application.
getAppointmentByToken(string $token): array RSVP landing data for an appointment token.
respondToAppointment(string $token, string $action): array Sends the RSVP answer (confirm or decline) as POST.
getGoogleTagCode(?string $publicId = ''): array Google Tag Manager snippets as ['head' => ..., 'body' => ...]. Returns empty strings without an id.
authenticate(bool $force = false): array Requests an access token. Pass true to bypass the session cache.
setAuthConfig(array $config): void Replaces the client credentials.
getAuthData(): array The current token and its expiration.

Job filter keys

setFilter() accepts a raw query string and takes over only these keys: job_ids, company_location_ids, departments, employments, internal_titles, language, search, address, area_search_distance, limit, page. Everything else is ignored. language and address are single-valued; the remaining list keys accept repeated parameters.

Response Shape

Every endpoint method returns the same envelope:

Requests use a 5 second connect timeout and a 15 second overall timeout. On HTTP 401 with an expired token the SDK re-authenticates once and retries, up to three attempts in total.

Authentication failures throw an Exception; transport failures do not — they arrive as status_code => 0 with a populated error.

License

See the license field in composer.json.

All versions of scope-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4||^8.0
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package werbeagentur_artrevolver/scope-php-sdk contains the following files

Loading the files please wait ...