jsanga-des/php-sharepoint-graph-api

PHP Client for Microsoft Graph API - SharePoint Operations

2.0.3 2025-08-29 09:18 UTC

Requires

• php: ^8.2
• firebase/php-jwt: ^6.11

Requires (Dev)

• phpunit/phpunit: ^11.0

GPL-3.0-or-later

• José Sánchez G.

• php
• API-Client
• sharepoint
• Office365
• microsoft-graph

README

Sencillo cliente PHP para interactuar con SharePoint Online a través de Microsoft Graph API. Versión 2.0.2

Descripción

Este cliente permite realizar operaciones básicas con SharePoint Online, incluyendo la gestión de archivos y carpetas a través de la API de Microsoft Graph. Soporta tres métodos de autenticación: Client Secret, Certificado PEM y PFX.

Características

• Autenticación con Microsoft Graph API
• Soporta múltiples entornos Sharepoint y configura cada uno de ellos, con sus respectivas credenciales.
• Múltiples métodos de autenticación: Client Secret, Certificado PEM y PFX
• Obtención de IDs de sitio y biblioteca
• Listado de archivos y carpetas
• Subida de archivos
• Eliminación de archivos
• Verificación de existencia de archivos y carpetas

Instalación con composer

Instalar la librería php-sharepoint-graph-api

composer require jsanga-des/php-sharepoint-graph-api:2.0.2

Incluir/disponer del autoloader

require_once __DIR__ . '/vendor/autoload.php';

Nota: Este paquete está disponible en Packagist

Ejecutar desde nuestro nuevo proyecto:

php vendor/jsanga-des/php-sharepoint-graph-api/scripts/setup.php

Alternativamente, se puede automatizar este paso agregando lo siguiente en el composer.json de tu proyecto principal:

"scripts": {
    "post-install-cmd": [
        "@setup-sharepoint"
    ],
    "post-update-cmd": [
        "@setup-sharepoint"
    ],
    "setup-sharepoint": [
        "php vendor/jsanga-des/php-sharepoint-graph-api/scripts/setup.php"
    ]
}

El comando anterior debe crearnos la siguiente estructura de carpetas:

mi-proyecto/
├── certs/
│   ├── (vacío) - Aquí debes incluri los certificados
├── examples/
│   ├── CheckCredentials.php
│   ├── DeleteFile.php
│   ├── FileExistsInFolder.php
│   ├── FolderExists.php
│   ├── ListFiles.php
│   ├── UploadFile.php
│   └── test_uploaded.txt
├── vendor/
│   └── ...
├── .env.sharepoint.example
├── composer.json
├── composer.lock
└── Sharepoint.php

Finalmente, crear el archivo .env en la raiz del proyecto.

Nota: Fijarse en el archivo .env.sharepoint.example

Por lo que la estructura final será de la siguiente manera:

mi-proyecto/
├── certs/
│   ├── (vacío) - Aquí debes incluri los certificados
├── examples/
│   ├── CheckCredentials.php
│   ├── DeleteFile.php
│   ├── FileExistsInFolder.php
│   ├── FolderExists.php
│   ├── ListFiles.php
│   ├── UploadFile.php
│   └── test_uploaded.txt
├── vendor/
│   └── ...
├── .env.sharepoint.example
├── .env
├── composer.json
├── composer.lock
└── Sharepoint.php

Instalación Manual

Clonar o descargar el repositorio:

git clone https://github.com/jsanga-des/php-sharepoint-graph-api.git

Ejecutar desde nuestro nuevo proyecto:

php vendor/jsanga-des/php-sharepoint-graph-api/scripts/setup.php

Alternativamente, se puede automatizar este paso agregando lo siguiente en el composer.json de tu proyecto principal:

"scripts": {
    "post-install-cmd": [
        "@setup-sharepoint"
    ],
    "post-update-cmd": [
        "@setup-sharepoint"
    ],
    "setup-sharepoint": [
        "php vendor/jsanga-des/php-sharepoint-graph-api/scripts/setup.php"
    ]
}

El comando anterior debe crearnos la siguiente estructura de carpetas:

mi-proyecto/
├── certs/
│   ├── (vacío) - Aquí debes incluri los certificados
├── examples/
│   ├── CheckCredentials.php
│   ├── DeleteFile.php
│   ├── FileExistsInFolder.php
│   ├── FolderExists.php
│   ├── ListFiles.php
│   ├── UploadFile.php
│   └── test_uploaded.txt
├── vendor/
│   └── ...
├── .env.sharepoint.example
├── composer.json
├── composer.lock
└── Sharepoint.php

Finalmente, crear el archivo .env en la raiz del proyecto.

Nota: Fijarse en el archivo .env.sharepoint.example

Por lo que la estructura final será de la siguiente manera:

mi-proyecto/
├── certs/
│   ├── (vacío) - Aquí debes incluri los certificados
├── examples/
│   ├── CheckCredentials.php
│   ├── DeleteFile.php
│   ├── FileExistsInFolder.php
│   ├── FolderExists.php
│   ├── ListFiles.php
│   ├── UploadFile.php
│   └── test_uploaded.txt
├── vendor/
│   └── ...
├── .env.sharepoint.example
├── .env
├── composer.json
├── composer.lock
└── Sharepoint.php

Inicialización del cliente:

use SharepointClient\SharepointClient;
use SharepointClient\Config\ConfigManager;

// Cargar configuración por nombre de entorno
$config = ConfigManager::getInstance('default');
// O Alternativamente: $config = ConfigManager::getInstance('entorno1');

// Crear el cliente
$client = new SharepointClient($config);

Configuración de entornos:

El cliente utiliza un sistema de entornos definido en el archivo ./Sharepoint.php. Cada sitio o instancia de SharePoint se configura aquí con sus credenciales, método de autenticación y valores generales de ejecución. Es importante no exponer aquí las credenciales. Aquí sólo se debe nombrar la variable de entorno que contiene el valor secreto.

return [
    'env' => [
        'debug' => true,
        'log_level' => 'DEBUG',
        'timeout' => 120,
        'connect_timeout' => 60,
    ],
    'sites' => [
        'default' => [
            'general' => [
                'client_id' => getenv('SHAREPOINT_ENTORNO1_CLIENT_ID'),
                'tenant_id' => getenv('SHAREPOINT_ENTORNO1_TENANT_ID'),
                'site_path' => getenv('SHAREPOINT_ENTORNO1_SITE_PATH'),
                'default_library' => getenv('SHAREPOINT_ENTORNO1_DEFAULT_LIBRARY'),
            ],
            'auth_method' => getenv('SHAREPOINT_ENTORNO1_AUTH_METHOD') ?? 'client_secret',
            'auth' => [
                'client_secret' => [
                    'secret' => getenv('SHAREPOINT_ENTORNO1_CLIENT_SECRET'),
                ],
                'certificate_pfx' => [
                    'path' => getenv('SHAREPOINT_ENTORNO1_PFX_PATH'),
                    'passphrase' => getenv('SHAREPOINT_ENTORNO1_PFX_PASSPHRASE'),
                ],
                'certificate_crt' => [
                    'cert_path' => getenv('SHAREPOINT_ENTORNO1_CERT_PATH'),
                    'key_path' => getenv('SHAREPOINT_ENTORNO1_KEY_PATH'),
                    'passphrase' => getenv('SHAREPOINT_ENTORNO1_KEY_PASSPHRASE'),
                ],
            ],
        ],
        // Otros entornos 'entorno2', 'entorno3', etc, con sus respectivas credenciales.
    ],
];

Nota: Puedes definir tantos entornos en sites como desees.

Variables de entorno

Ejemplo para el archivo .env

SHAREPOINT_EMPRESA_A_CLIENT_ID=xxxx-xxxx-xxxx-xxxx
SHAREPOINT_EMPRESA_A_TENANT_ID=yyyy-yyyy-yyyy-yyyy
SHAREPOINT_EMPRESA_A_SITE_PATH=miempresa.sharepoint.com:/sites/MiSitio
SHAREPOINT_EMPRESA_A_DEFAULT_LIBRARY=Documentos
SHAREPOINT_EMPRESA_A_AUTH_METHOD=client_secret
SHAREPOINT_EMPRESA_A_CLIENT_SECRET=mi-secret
SHAREPOINT_EMPRESA_A_PFX_PATH=certificados/mi-certificado.pfx
SHAREPOINT_EMPRESA_A_PFX_PASSPHRASE=mi-password
SHAREPOINT_EMPRESA_A_CERT_PATH=certificados/mi-certificado.crt
SHAREPOINT_EMPRESA_A_KEY_PATH=certificados/private.key
SHAREPOINT_EMPRESA_A_KEY_PASSPHRASE=mi-key-password

SHAREPOINT_EMPRESA_B_CLIENT_ID=xxxx-xxxx-xxxx-xxxx
SHAREPOINT_EMPRESA_B_TENANT_ID=yyyy-yyyy-yyyy-yyyy
SHAREPOINT_EMPRESA_B_SITE_PATH=miempresa.sharepoint.com:/sites/MiSitio
SHAREPOINT_EMPRESA_B_DEFAULT_LIBRARY=Documentos
SHAREPOINT_EMPRESA_B_AUTH_METHOD=client_secret
SHAREPOINT_EMPRESA_B_CLIENT_SECRET=mi-secret
SHAREPOINT_EMPRESA_B_PFX_PATH=certificados/mi-certificado.pfx
SHAREPOINT_EMPRESA_B_PFX_PASSPHRASE=mi-password
SHAREPOINT_EMPRESA_B_CERT_PATH=certificados/mi-certificado.crt
SHAREPOINT_EMPRESA_B_KEY_PATH=certificados/private.key
SHAREPOINT_EMPRESA_B_KEY_PASSPHRASE=mi-key-password

SHAREPOINT_OTRO_ENTORNO_CLIENT_ID=xxxx-xxxx-xxxx-xxxx
SHAREPOINT_OTRO_ENTORNO_TENANT_ID=yyyy-yyyy-yyyy-yyyy
SHAREPOINT_OTRO_ENTORNO_SITE_PATH=miempresa.sharepoint.com:/sites/MiSitio
SHAREPOINT_OTRO_ENTORNO_DEFAULT_LIBRARY=Documentos
SHAREPOINT_OTRO_ENTORNO_AUTH_METHOD=client_secret
SHAREPOINT_OTRO_ENTORNO_CLIENT_SECRET=mi-secret
SHAREPOINT_OTRO_ENTORNO_PFX_PATH=certificados/mi-certificado.pfx
SHAREPOINT_OTRO_ENTORNO_PFX_PASSPHRASE=mi-password
SHAREPOINT_OTRO_ENTORNO_CERT_PATH=certificados/mi-certificado.crt
SHAREPOINT_OTRO_ENTORNO_KEY_PATH=certificados/private.key
SHAREPOINT_OTRO_ENTORNO_KEY_PASSPHRASE=mi-key-password

Nota: Puedes definir varios entornos (./Sharepoint.php) y referenciar qué variables de entorno deben emplear esos entornos. Lo siguiente será incluir esas variables de entorno en tu servidor, y podrás cargar la configuración correspondiente con ConfigManager::getInstance('otro_entorno').

Requisitos previos

Dependencias del proyecto

• PHP: >= 8.2
• Extensiones PHP requeridas:
  • ext-curl
  • ext-json
• Dependencias Composer:
  • firebase/php-jwt: ^6.11

Autenticación mediante CLIENT_SECRET

Variable	Descripción
CLIENT_ID	ID de aplicación (cliente) - Identificador único de tu aplicación registrada
TENANT_ID	ID de inquilino (tenant) - Identificador de tu organización en Azure AD
CLIENT_SECRET	Valor del secreto de cliente - El valor secreto generado en Azure AD

Autenticación mediante certificado PFX

Variable	Descripción
CLIENT_ID	ID de aplicación (cliente) - Identificador único de tu aplicación registrada
TENANT_ID	ID de inquilino (tenant) - Identificador de tu organización en Azure AD
PFX_FILE_PATH	Certificado en formato PFX/PKCS12
PFX_FILE_PASSWORD	Password para poder emplear el certificado

Autenticación mediante certificado PEM

Variable	Descripción
CLIENT_ID	ID de aplicación (cliente) - Identificador único de tu aplicación registrada
TENANT_ID	ID de inquilino (tenant) - Identificador de tu organización en Azure AD
PEM_FILE_PATH	Certificado en formato PEM
PEM_FILE_KEY	Archivo de clave privada

Ejemplos de uso

/ejemplos
├── TestDeleteFile.php            
├── TestDeleteFileBySitePath.php    
├── TestFileExistsInFolder.php     
├── TestFolderExists.php          
├── TestListFiles.php              
├── TestListFilesBySitePath.php     
├── TestUploadFile.php            
└── TestUploadFileBySitePath.php        

Operaciones básicas con archivos

• TestUploadFile.php → Subir un archivo
• TestListFiles.php → Listar archivos
• TestFileExistsInFolder.php → Verificar si existe un archivo
• TestDeleteFile.php → Eliminar un archivo

Operaciones con rutas específicas del sitio

• TestUploadFileBySitePath.php → Subir archivo usando ruta del sitio
• TestListFilesBySitePath.php → Listar archivos por ruta del sitio
• TestDeleteFileBySitePath.php → Eliminar archivo por ruta del sitio

Operaciones con carpetas

• TestFolderExists.php → Verificar si existe una carpeta

Documentación adicional

• Microsoft Graph API Documentation
• SharePoint REST API Reference

Contribuciones

Las contribuciones son bienvenidas. Por favor, abre un issue o envía un pull request.

Licencia

GNU General Public License v3.0