bnomei/kirby3-seobility

Kirby 3 Plugin to use Seobility.net

1.4.1 2022-04-26 14:31 UTC

Requires

• php: >=7.4.0
• getkirby/composer-installer: ^1.2

Requires (Dev)

• getkirby/cms: ^3.6
• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^9.5

MIT

• Bruno Meilick

• keyword
• site
• check
• seo
• Audit
• ranking
• suggestion
• term
• TF-IDF
• kirby3
• kirby3-cms
• kirby3-plugin
• TFIDF

README

Kirby 3 Plugin to use Seobility.net

Commercial Usage

Support Seobility.net

Unless you enter a paid API key this plugin will scrape the web based tools of Seobility.net. They know about this, did send me a really nice email and decided for now not to block the scrapping. Go signup for an account with API access to support them! The api is also a tiny bit faster than the scrapper.

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

Scrapper

• keyword check (scrapper for web based tool, not a free api)

Paid API

• keyword check
• real time SERP ranking
• term suggestion
• add more features of paid api

Usage

Keyword check (scrapper, paid)

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();

To show the score of the keywordcheck field the plugin will scrape the web based tools of Seobility.net or query your paid API account 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. The paid API is a tiny bit faster.

Real time SERP Ranking (paid)

This field is a button to trigger a real time, synchronous (direct) API. The average response time is up to 30 seconds and it will return the rank, title and description as listed on the specified search engine (see settings).

⚠️ You need to have a keywordcheck field on the same blueprint and at least one keyword set to get a SERP ranking.

site/blueprints/default.yml

fields:
  serpranking:
    headline: Seobility.net SERP Ranking
    label: Fetch Rank
    progress: Fetching Rank...
    # notranked: Page is not ranked.
    type: ranking

Term Suggestion (paid)

This field is a button to trigger a term suggestion (more, less, ok) for the specified search engine (see settings).

⚠️ You need to have a keywordcheck field on the same blueprint and at least one keyword set to get further term suggestions.

site/blueprints/default.yml

fields:
  termsuggestion:
    headline: Seobility.net Term Suggestion
    label: Fetch Term Suggestions
    progress: Fetching Term Suggestions...
    type: termsuggestion

Robots.txt

If you have a custom robots.txt-file or use my plugin make sure the Seobility.net 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: /

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.