Download the PHP package colorfield/mastodon-api without Composer

On this page you can find all versions of the php package colorfield/mastodon-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of colorfield/mastodon-api

Informations about the package mastodon-api

Mastodon API PHP

PHP wrapper for the Mastodon API, that includes OAuth helpers. Guzzle based.

This is a plain API wrapper, so it makes it more resilient to changes (new parameters, ...) from the API by letting the developer pass the desired endpoint and parameters.

Quick start

Install it via Composer. Latest version requires PHP 8.1. For previous versions of PHP, use v0.1.0.

  1. Get an instance from the instance list.
  2. Get endpoints from the Mastodon API documentation: Getting started with the API and Guidelines and best practices

Some requests, like public timelines, do not require any authentication.

Get public data.

Initialize the API.

Request a public endpoint.

which is equivalent to

where the 3rd parameter indicates that we don't require any authentication.

Authenticate with OAuth

This is needed for endpoints that are requiring a token.

To get OAuth credentials, a lightweight client is also available in test_oauth, via a local PHP server. It provides the client id, client secret and bearer. See the Development section below.

Register your application

The default configuration is limited to the read and write scopes. You can modify it via

or alternatively use enum

Note that this must be done while obtaining the token, so you cannot override this after. More about scopes.

Get the authorization code

  1. Get the authorization URL $authorizationUrl = $oAuth->getAuthorizationUrl();
  2. Go to this URL, authorize and copy the authorization code.

Get the bearer

  1. Store the authorization code in the configuration value object. $oAuth->config->setAuthorizationCode(xxx);

  2. Then get the access token. As a side effect, it is store in the Configuration value object. $oAuth->getAccessToken();

Use the Mastodon API

Instantiate the Mastodon API with the configuration

The OAuth credentials should be stored in the Configuration value object for later retrieval.

User login

Login with Mastodon email and password.

Get

Get credentials (assumes by default that authentication is provided).

Get followers

Post

Clear notifications

@todo complete with delete, put, patch and stream.

Development

Manual testing tools

OAuth

An interactive demo is available.

  1. Clone the GitHub repository.
  2. cd in the cloned directory
  3. Run composer install
  4. Run php -S localhost:8000
  5. In your browser, go to http://localhost:8000/test_oauth.php
  6. You will get the client_id and client_secret, click on the authorization URL link, then confirm the authorization under Mastodon and copy the authorization code.
  7. Get the bearer: click on the "Get access token" button.
  8. Authenticate with your Mastodon username (email) and password: click on "Login".

Mastodon API

  1. Make a copy of .env.local as .env
  2. Define the information obtained with OAuth and your Mastodon email and password.
  3. In your browser, go to http://localhost:8000/test_api.php

All versions of mastodon-api with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1.0
guzzlehttp/guzzle Version ^7.0.0
vlucas/phpdotenv Version ^5.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package colorfield/mastodon-api contains the following files

Loading the files please wait ....