foxycart/foxyclient

FoxyClient - a PHP Guzzle based API Client for working with the Foxy Hypermedia API

2.0.1 2017-04-07 21:23 UTC

README

FoxyClient - a PHP Guzzle based API Client for working with the Foxy Hypermedia API

Please see the Foxy Hypermedia API documentation for more information.

Installation

The best way to get started with FoxyClient is to run the foxyclient-php-example code.

Once you're familiar with how it works, you can add it as a composer package to your application as the example code does or via Packagist:

  • Install Composer

curl -sS https://getcomposer.org/installer | php

  • Add to your project

php composer.phar require foxycart/foxyclient:~1.0

If you need Guzzle 6 instead of Guzzle 5, use:

php composer.phar require foxycart/foxyclient:~2.0

Usage

As mentioned above, begin by getting familiar with the example code. The bootstrap.php file in particular is useful for configuring FoxyClient within your application. Please note how it takes advantage of HTTP caching and CSRF protection which are important for the performance and security of your application.

FoxyClient supports all HTTP methods for our Hypermedia API. It also automatically handles OAuth token refreshes and handles authorization code grants. It does not specify a persistance layer for storing OAuth tokens so you can implement that however you want. You can also support a static service with no database which would only use the client_id, client_secret, and refresh_token to obtain a new access_token as needed.

Tests

For Behat tests, please see the the example code.

Config Options

  • use_sandbox: Set to true to work with https://api-sandbox.foxycart.com. This is highly recomended when first getting familiar with the system (defaults to false).
  • client_id: Your OAuth Client id.
  • client_secret: Your OAuth Client Secret.
  • access_token: Your OAuth Acccess Token.
  • access_token_expires: A timestamp for when the access_token needs to be refreshed. If you happen to already have a stored token, you can set this here. It will be maintained via time() + expires_in.
  • refresh_token: OAuth Refresh Token.
  • handle_exceptions: Defaults to true. Set to false to let Guzzle exceptions bubble up to your application so you can handle them directly.
  • api_home: Used internally for Foxy testing.
  • authorization_endpoint: Used internally for Foxy testing.

HTTP methods

  • get($uri, $post = null)
  • post($uri, $post = null)
  • patch($uri, $post = null)
  • put($uri, $post = null)
  • delete($uri, $post = null)
  • options($uri, $post = null)
  • head($uri, $post = null)

API Methods

  • updateFromConfig($config): Update configuration options via an array
  • clearCredentials(): Clear all credentials so you can connect to the API with no OAuth
  • getLink($link_rel_string): Used to get the href of a given link relationship such as "self" or "fx:store". It also supports the short version of just "store".
  • getLinks(): Returns an array of link relationships the client has seen so far in the rel => href format. Each request stores the links in the links array.
  • clearLinks(): Clear saved links from previous API calls. Helpful for link relationships like "checkout_types" which can be returned from both a store resource and as a property helper.
  • setAccessToken($access_token) / getAccessToken(): OAuth access token
  • setAccessTokenExpires($access_token_expires) / getAccessTokenExpires(): OAuth expiration times
  • setRefreshToken($refresh_token) / getRefreshToken(): OAuth refresh token
  • setClientId($client_id) / getClientId(): OAuth client id
  • setClientSecret($client_secret) / getClientSecret(): OAuth client secret
  • setUseSandbox($use_sandbox) / getUseSandbox(): boolean for connecting to the API sandbox
  • getApiHome(): the API starting homepage
  • getErrors($data): Given a response payload, it will normalize errors and return an array of them (or any empty array).
  • getLastStatusCode(): Returns the last HTTP status code.
  • getLastResponseHeader($header): Get a header (such as "Location") from the previous response.
  • setAcceptContentType($accept_content_type): Set the Accept header content type used for the all future requests. All supported json content types on the FoxyCart API are supported such as application/hal+json and application/vnd.siren+json.
  • getAcceptContentType(): get the Accept header content type
  • getAuthorizationEndpoint(): The Authorization Code Grant server endpoint url. You'll need to forward users to this to let them grant your application access to their store or user.
  • getOAuthTokenEndpoint(): The OAuth token endpoint. Note: you shouldn't have to use this as the library takes care of all OAuth functionality for you.
  • getAccessTokenFromAuthorizationCode($code): Used when returning from our Authorization server in order to obtain an access_token and refresh_token.
  • getAccessTokenFromClientCredentials(): If we don't have a refresh token, we can use this method to obtain an access_token using just the client credentials.