Git Product home page Git Product logo

freeagent-php's Introduction

Freeagent-PHP

A PHP toolkit for accessing the FreeAgent API.


Installation

To install simply include the Freeagent.php file in your PHP script, and instantiate the class.

include('/path/to/Freeagent.php');
$client = new Freeagent('your-app-id', 'your-app-secret');

Authentication

Authentication is through the OAuth Protocol. An example flow is included in the examples folder.

Usage

Once you have authenticated you can begin using the toolkit to call the API.

GET requests

GET requests are made to get existing resources, and work as follows:

$client->get('resource_name', array('optional_param' => 'value'));

POST requests

POST requests are made to create new resources, and work as follows:

$client->post('resource_name', array('required_param' => 'value'));

PUT requests

PUT requests are made to update existing resources, and work as follows:

$client->put('resource_name', array('param_to_update' => 'value'));

DELETE requests

DELETE requests are made to delete existing resources, and work as follows:

$client->delete('resource_name');

Resources

The list of resources consumable by the API can be found at https://dev.freeagent.com/docs

Support

If you require help or further explanation, feel free to message us on twitter (@thoughtco @ryanhmitchell)

freeagent-php's People

Contributors

aluzardo avatar enru avatar ryanmac avatar ryanmitchell avatar theninthnode avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.