https://github.com/kawax/laravel-mastodon-api
https://github.com/kawax/laravel-mastodon-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kawax/laravel-mastodon-api
- Owner: kawax
- License: mit
- Created: 2017-05-10T07:43:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-23T03:38:52.000Z (5 months ago)
- Last Synced: 2025-04-09T09:45:04.950Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 69.3 KB
- Stars: 25
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mastodon API for Laravel
## Requirements
- PHP >= 8.2
- Laravel >= 11.0
## Installation
### Composer
```
composer require revolution/laravel-mastodon-api
```
## Usage
### Registering an application
#### By Web UI
1. Go to your Mastodon's user preferences page.
2. Go to development page.
#### By API
```php
use Revolution\Mastodon\Facades\Mastodon;
class MastodonController
{
public function app()
{
$client_name = 'my-app';
$redirect_uris = 'https://my-instance/callback';
$scopes = 'read write follow';
$app_info = Mastodon::domain('https://example.com')
->createApp($client_name, $redirect_uris, $scopes);
dd($app_info);
//[
// 'id' => '',
// 'client_id' => '',
// 'client_secret' => '',
//]
}
}
```
### OAuth authentication
Use https://github.com/kawax/socialite-mastodon
Save account info.(`id`, `token`, `username`, `acct`...and more.)
### Get statuses
```php
use Revolution\Mastodon\Facades\Mastodon;
$statuses = Mastodon::domain('https://example.com')
->token('token')
->statuses($account_id);
dd($statuses);
```
### Get one status
```php
use Revolution\Mastodon\Facades\Mastodon;
$status = Mastodon::domain('https://example.com')
->token('token')
->status($status_id);
dd($status);
```
### Post status
```php
use Revolution\Mastodon\Facades\Mastodon;
Mastodon::domain('https://example.com')->token('token');
$response = Mastodon::createStatus('test1');
$response = Mastodon::createStatus('test2', ['visibility' => 'unlisted']);
dd($response);
```
### Any API by `get` or `post` method
```php
use Revolution\Mastodon\Facades\Mastodon;
$response = Mastodon::domain('https://example.com')
->token('token')
->get('/timelines/public', ['local' => true]);
```
```php
use Revolution\Mastodon\Facades\Mastodon;
$response = Mastodon::domain('https://example.com')
->token('token')
->post('/follows', ['uri' => '']);
```
### Any API can call by `call` method
```php
use Revolution\Mastodon\Facades\Mastodon;
$response = Mastodon::domain('https://example.com')
->token('token')
->call('DELETE', '/statuses/1');
```
### Other methods
Check public methods in `Contracts/Factory.php`
## Streaming API
Edit `$token` and `$url` in streaming_example.php
```
php ./streaming_example.php
```
`Ctrl+C` to quit.
## LICENSE
MIT