README

Laravel Client for the Podscan.fm API

This package provides a simple and easy-to-use API client for the Podscan.fm API

Installation

You can install the package via composer:

composer require helgesverre/laravel-podscan

You can publish the config file with:

php artisan vendor:publish --tag="podscan-config"

This is the contents of the published config file:

return [
    'api_key' => env('PODSCAN_API_KEY'),
];

Usage

Client Instantiation

Create an instance of the Podscan client to start interacting with the API. This instance will be your primary interface for sending requests to Podscan.AI.

use HelgeSverre\Podscan\Podscan;

// Instantiate the client
$podscan = new Podscan(apiKey: config('podscan.api_key'));

// Or use the Facade (Laravel)
Podscan::alerts();
Podscan::category();
Podscan::episodes();
Podscan::podcasts();
Podscan::teams();

Resources

Alerts

Podscan::alerts()->list();
Podscan::alerts()->create();
Podscan::alerts()->get();
Podscan::alerts()->update();
Podscan::alerts()->delete();
Podscan::alerts()->mentions();
Podscan::alerts()->mention();

Episodes

Podscan::episodes()->search();
Podscan::episodes()->paginatedSearch();
Podscan::episodes()->recent();
Podscan::episodes()->get();

Podcasts

Podscan::podcasts()->suggest();
Podscan::podcasts()->search();
Podscan::podcasts()->paginatedSearch();
Podscan::podcasts()->get();
Podscan::podcasts()->episodes();
Podscan::podcasts()->paginatedEpisodes();

Teams

Podscan::teams()->list();

Testing

cp .env.example .env
composer test
composer analyse src

License

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

Disclaimer

Podscan and the Podscan logo are trademarks of Arvid Kahl. This package is not affiliated with Podscan or Arvid Kahl in any way.

helgesverre / laravel-podscan

Maintainers

Details