Kirby 3 Seobility

Kirby 3 Plugin to use free and paid API of Seobility.net

Commercial Usage

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno
 

Installation

• unzip master.zip as folder site/plugins/kirby3-seobility or
• git submodule add https://github.com/bnomei/kirby3-seobility.git site/plugins/kirby3-seobility or
• composer require bnomei/kirby3-seobility

Roadmap

• add features of free api
• add features of paid api

Usage free API

Add the field to your blueprint.

site/blueprints/default.yml

fields:
  keywordcheck: # the field id must be exactly like this
    label: Seobility.net Keywordcheck
    type: keywordcheck

Enter keywords(s) in the panel. Save and get a score. Clicking on the score will take you to new browser tab with the full report.

You can also read the score with a pagemethod if you need it in you business logic.

any template

echo $page->keywordcheckScore();

Robots.txt

If you have a custom robots.txt-file or use my plugin make sure the Seobility bot can crawl the website. My Robots.txt plugin must be in non debug mode.

In a custom robots.txt-file add something like this:

User-Agent: seobility
Allow: /

How it works

The plugin will query the free or paid API and cache the results until the content page is modified or cache expires (see settings below).

⚠️ EVERY time you press the save button in the panel for a page with this field a request to the API will be made. This might delay saving by a second or two.

Localhost = No Score

The plugin will not query the API on localhost since the API would not be able to read the HTML content of your page.

No cache when debugging

When Kirbys global debug config is set to true the complete plugin cache will be flushed BUT caches will be created. This will make you live easier – trust me.

Setup paid API

You can set the apikey in the config if you want to use features from the paid api.

site/config/config.php

return [
    // other config settings ...
    'bnomei.seobility.apikey' => 'YOUR-KEY-HERE',
];

You can also set a callback if you use the dotenv Plugin.

site/config/config.php

return [
    // other config settings ...
    'bnomei.seobility.apikey' => function() { return env('SEOBILITY_APIKEY'); },
];

Settings

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.