Download the PHP package buddy-works/buddy-works-php-api without Composer

On this page you can find all versions of the php package buddy-works/buddy-works-php-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 buddy-works/buddy-works-php-api

Informations about the package buddy-works-php-api

Buddy Works APIs PHP SDK

Minimum PHP Version buddy branch Latest Stable Version GitHub

Official PHP client library for Buddy Build Server with CI.

Installation

This library is distributed on packagist and is working with composer. In order to add it as a dependency, run the following command:

Compatibility

PHP version SDK version
^8.0 1.4
^7.3 1.3
^7.2 1.2
5.5 1.1

Usage of OAUTH

First you need to add application in your Buddy ID.

You will then obtain clientId & clientSecret to execute this code:

scopes are arrays of strings - help

state should be an unguessable random string. It is used to protect against cross-site request forgery attacks.

redirectUrl is optional more

You should redirect the user to the created URL. Upon authorization, the user should get back to your page (configured in application or passed to the method)

query params will get you the code & state. State should be the same as you passed before. Code is used in next step to exchange for access token:

State should be the same as in getAuthorizeUrl method.

Usage of direct tokens

You can also use API Tokens.

That functionality is provided for testing purposes and will only work for individual tokens generated per user.

All requests will be called on behalf of the user who provided token.

API's

For detailed info what send for which method, error codes, rates & limits - check Buddy documentation

To start using api you should pass to Buddy constructor acquired access token.

Workspaces

Get workspaces

Get workspace

Webhooks

Get webhooks

Add webhook

Get webhook

Edit webhook

Delete webhook

Tags

Get tags

Get tag

Ssh Keys

Get keys

Add key

Delete key

Get key

Source

Get contents

Add file

Edit file

Delete file

Projects

Get projects

Add project

Get projects

Edit project

Delete project

Get project members

Add project member

Get project member

Edit project member

Delete project member

Profile

Get user

Edit user

Pipelines

Get pipelines

Add pipeline

Get pipeline

Edit pipeline

Delete pipeline

Get pipeline actions

Add pipeline action

Get pipeline action

Edit pipeline action

Delete pipeline action

Permissions

Get permissions

Add permission

Get permission

Edit permission

Delete permission

Members

Get members

Add member

Get member

Edit member

Delete member

Get member projects

Integrations

Get integrations

Get integration

Groups

Get groups

Add group

Get group

Edit group

Delete group

Get group members

Add group member

Get group member

Delete group member

Executions

Get executions

Run execution

Get execution

Cancel execution

Retry execution

Emails

Get emails

Add email

Delete email

Commits

Get commits

Get commit

Compare commits

Branches

Get branches

Get branch

Add branch

Delete branch

License

Please see the license file for more information.

All versions of buddy-works-php-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
ext-mbstring Version *
guzzlehttp/guzzle Version ~6.0
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 buddy-works/buddy-works-php-api contains the following files

Loading the files please wait ....