README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require always-open/oxylabs-api

You can publish and run the migrations with:

php artisan vendor:publish --tag="oxylabs-api-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="oxylabs-api-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="oxylabs-api-views"

Usage

$oxylabsApi = new AlwaysOpen\OxylabsApi();
echo $oxylabsApi->echoPhrase('Hello, AlwaysOpen!');

Parse status

parse_status_code is a field of a response the Oxylabs parser actually produced, not of every Oxylabs response. When the parser never ran - bot-check / CAPTCHA / error-page classes, unsupported page types, raw type=html retrievals - Oxylabs omits the key entirely. The content DTOs therefore type it as ?int, and getParseStatusCode() distinguishes three states:

state	`parse_status_code`	`hasParseStatus()`	`getParseStatusCode()`
vendor reported a status we model	e.g. `12000`	`true`	that case, e.g. `ParseStatus::SUCCESS`
vendor reported a status we do not model yet	e.g. `12001`	`true`	`ParseStatus::UNKNOWN`
vendor reported no status at all	`null`	`false`	`ParseStatus::NOT_REPORTED`

ParseStatus::NOT_REPORTED is a local sentinel (0) deliberately outside the vendor's 120xx numbering space - it is never a code Oxylabs sent.

A NOT_REPORTED status means every other field on that content object is untrustworthy. Guard on $content->success() or $content->hasParseStatus(), never on instanceof (now satisfied by an all-null object) and never on empty() (always false for an object).

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

always-open / oxylabs-api

Package info

Security

Statistics