README

Introduction

The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc., The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you're an existing financial services partner that wants access, contact your local Partner Manager. If you're a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner., These endpoints are related to managing authentication tokens and identity for Xero API, This is the Xero Projects API

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "xero-apimatic/xero-apimatic-sdk:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "xero-apimatic/xero-apimatic-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/xero-apimatic/xero-apimatic-sdk#1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

use XeroApIsLib\Logging\LoggingConfigurationBuilder;
use XeroApIsLib\Logging\RequestLoggingConfigurationBuilder;
use XeroApIsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use XeroApIsLib\Environment;
use XeroApIsLib\Authentication\Oauth2CredentialsBuilder;
use XeroApIsLib\Models\OauthScopeOauth2;
use XeroApIsLib\Authentication\BasicAuthCredentialsBuilder;
use XeroApIsLib\XeroApIsClientBuilder;

$client = XeroApIsClientBuilder::init()
    ->oauth2Credentials(
        Oauth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret',
            'OAuthRedirectUri'
        )
            ->oauthScopes(
                [
                    OauthScopeOauth2::EMAIL,
                    OauthScopeOauth2::OPENID
                ]
            )
    )
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• OAuth2 (OAuth 2 Authorization Code Grant)
• BasicAuth (Basic Authentication)

List of APIs

• Accounting
• Asset
• Bank Feeds
• Identity
• Project

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• FileWrapper
• ApiResponse