delaneymethod/sharepoint-api

A minimal implementation of Sharepoint 2013 REST API

Sharepoint 2013 REST API

, _(*1)

This is a minimal PHP implementation of the Sharepoint 2013 REST API. It contains only the methods needed for our flysystem-sharepoint adapter. We are open however to PRs that add extra methods to the client., _(*2)

Here are a few examples on how you can use the package:, _(*3)

use DelaneyMethod\Sharepoint\Client as SharepointClient;

$siteName = 'YOUR_TEAM_SITE_NAME';
$siteUrl = 'https://YOUR_SITE.sharepoint.com';
$publicUrl = 'https://YOUR_SITE.sharepoint.com/:i:/r/sites/YOUR_TEAM_SITE_NAME/Shared%20Documents'
$clientId = 'YOUR_CLIENT_ID';
$clientSecret = 'YOUR_CLIENT_SECRET';
$verify = false; // See http://docs.guzzlephp.org/en/stable/request-options.html#verify
$accessToken = 'YOUR_ACCESS_TOKEN';

$client = new SharepointClient($siteName, $siteUrl, $publicUrl, $clientId, $clientSecret, $verify, $accessToken);

// Create a folder
$client->createFolder($path);

// Delete a folder
$client->delete($path);

// Upload a file
$client->upload($path, $contents);

Installation

You can install the package via composer:, _(*4)

composer require delaneymethod/sharepoint-api

Usage

The first thing you need to do is get an authorisation token from Sharepoint. Sharepoint has made this very easy. You can register a new App within your Sharepoint Site that can be used to generate a client ID and Secret. You'll find more info at Authorizing REST API calls against SharePoint Site., _(*5)

You can read the whole article for additional knowledge but the first step is the only step you're interested in for our flysystem-sharepoint adapter to work., _(*6)

With an authorization token you can instantiate a DelaneyMethod\Sharepoint\Client., _(*7)

Look in the source code of DelaneyMethod\Sharepoint\Client to discover the methods you can use., _(*8)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*9)

Contributing

Please see CONTRIBUTING for details., _(*10)

Security

If you discover any security related issues, please email hello@delaneymethod.com instead of using the issue tracker., _(*11)

License

The MIT License (MIT). Please see License File for more information., _(*12)