xovi/sdk

There is no license information available for the latest version (dev-main) of this package.

dev-main 2024-07-24 05:16 UTC

Requires

• guzzlehttp/guzzle: ^7.9

Requires (Dev)

• phpunit/phpunit: ^9
• symfony/dotenv: ^7.1

Unknown License

README

Note

This package is work in progress. Not all methods are implemented yet. Please only use it in you production code if you are a real badass.

Install

composer require xovi/sdk

Example

$client = new \Xovi\Sdk\Client('myPersonalKey');
$domains = $client->getKeywordsService()->getRank('google.de');

foreach($domains as $domain) {
    echo $domain->getDomain() . "\n";
}

Implemented Services and Methods

Address Book

• addPerson
• getPersons
• getOrganisations

Keywords

• getRank - Returns the strongest domains within a search engine sorted by OVI.
• getSearchEngines - Returns all daily crawled or weekly crawled search engines. (Contains data relevant for other functions).

User

• getXoviLimits - Returns all usage limits of the tool.
• getCreditState - Returns the current status of your credit data.

How to run tests

All methods are unit tested. As a normal user you don't have to run tests at all but if want to help with this open source library it will help you a lot.

Add your API key

To run the tests you have to add your API key to a file .env.local with the following content. You have to change the key in that file to match your key.

XOVI_API_KEY="f27d2abf6bf0a96ebarec196cd196a0b"

Run tests

After you added the key to the env file you just need to run the following command.

php vendor/bin/phpunit --bootstrap tests/autoload.php tests