README

Office 365 API - PHP SDK

This is a package for the Microsoft 365 implementation of KPN.

SERVER COMMUNICATION

RoutIT

This package will not communicate directly with KPN but with an intermediate party called RoutIT. RoutIT handles every other request detail.

Authentication

Each request must contain a header for basic authentication

PACKAGE

OfficeClient

The office client is the API for this package. Example setup

<?php declare(strict_types = 1);

use SandwaveIo\Office365\Office\OfficeClient;

$client = new OfficeClient(
    'https://my.awesome.domain',
    'username',
    'password',
);

Testing with the OfficeClient

The OfficeClient accepts an array as fourth parameter. This array will be merged together with the default GuzzleClient parameters. This gives the benefit of setting a handler for mocking for example.

Default GuzzleHttp options:

[
    'auth' => ['username', 'password'],
    'base_uri' => 'https://somehost',
    'headers' => [
        'Content-Type' => 'text/xml; charset=UTF8'
    ],
]

Instantiate the OfficeClient with a MockHandler

$mock = new MockHandler([
    new Response(200, ['X-Foo' => 'Bar'], 'Hello, World'),
    new Response(202, ['Content-Length' => 0]),
    new RequestException('Error Communicating with Server', new Request('GET', 'test'))
]);

$handlerStack = HandlerStack::create($mock);

$officeClient = new OfficeClient('username', 'password', ['handler' => $handlerStack]);

Available components and their methods

Customer

Create

Accepts

(string) $name (the customer name)

$client = new OfficeClient('https://my.awesome.domain', 'username', 'password');
$customer = $client->customer->create('name', ...);

Asynchronous requests

Subscribed events

Not every request will be synchronous and will give back a resource immediately. RoutIT will call our webhook with the particular object that has been created. This will cause that the Office365 package dispatches an event. Each subscriber that is attached to that particular event will receive the notification.

Subscribe to an event

For example: a customer create request is sent. RoutIT will not give back the resource immediately but will send this later through the webhook. In order to subscribe for this particular event, a new class must be created that implements the CustomerObserverInterface. Each component holds his own observers. The interface name will always look like this {ComponentName}ObserverInterface.

class CustomerCreateListener implements CustomerObserverInterface
{
    public function execute(Customer $customer): void
    {
        echo $customer->getName();
    }
}

In the above class, the CustomerObserverInterface is created and the execute method is implemented. It can now be attached together with an event it should listen to. In this case OfficeEvent::CUSTOMER_CREATE.

$client->webhook->addEventSubscriber(OfficeEvent::CUSTOMER_CREATE, new CustomerCreateListener());
$response = $client->webhook->parse($xml);

Available requests

The following requests are available in this package:

MicrosoftTenantDomainOwnershipCheckRequest_V1

The MicrosoftTenantDomainOwnershipCheckRequest can be used to check whether an IRMA client has access to an existing Microsoft tenant. A customer has access if:

There is 'delegated management' active on this tenant. This can be arranged in the Microsoft Partner Center.
There is a correct TXT record on the domain.
There is an active Microsoft Customer Agreement.

MicrosoftTenantExistsCheckRequest_V1

The MicrosoftTenantExistsCheckRequest can be used to check whether the tenant exists.

NewCustomerRequest_V3

Creating a new customer in the backend system Irma.

ModifyCustomerRequest_V3

Modify a existing customer in the backend system Irma.

NewCloudLicenseOrderRequest_V2

Place a order for the new cloud license including possible add-ons.

ModifyOrderQuantityRequest_V1

Adjust the item amount of an order.

NewCloudLicenseAddOnOrderRequest_V1

Adding an add-on to an existing cloud license order.

TerminateOrderRequest_V2

The TerminateOrderRequest_V2 can be used to cancel an active order.

OrderSummaryRequest_V1

With the request you can get a summary of the orders of a customer. Maximum 2500 order for each call. If you want to see more orders, a next set can be retrieved using the 'skip' option.

sandwave-io / office-365-php

Maintainers

Details