Connexion

Registre

Hapio lance un SDK pour PHP - Simplifier l'intégration avec l'API de réservation et de planification

Au cours des dernières semaines, nous avons travaillé sur un SDK pour PHP, afin de permettre aux développeurs PHP de démarrer plus facilement avec Hapio. Nous sommes maintenant heureux d'annoncer sa mise à disposition du public.

Le SDK Hapio pour PHP est conçu pour rationaliser l'intégration des capacités de réservation et de planification de Hapio dans les applications PHP, fournissant aux développeurs un outil puissant pour améliorer la fonctionnalité de leurs projets.

Configuration requise

Avant de commencer à utiliser le SDK Hapio pour PHP, les développeurs doivent s'assurer que leur environnement répond aux exigences suivantes :
PHP 8.2 ou plus récent.

Pour commencer

L'intégration du SDK Hapio dans un projet PHP est un processus simple. Les développeurs peuvent utiliser Composer, un gestionnaire de dépendances PHP populaire, pour inclure le SDK dans leur projet. Voici comment commencer :

Ouvrez le terminal ou l'invite de commande de votre projet.
Exécutez la commande Composer suivante :

coquille



composer require hapio/hapio-sdk-php

Une fois le SDK installé, les développeurs peuvent commencer à l'utiliser dans leurs projets.

Travailler avec le SDK

L'utilisation du SDK Hapio pour PHP est aussi simple que l'instanciation d'un client API et la mise au travail. Vous trouverez ci-dessous un exemple d'utilisation du SDK :

php



// Require the Composer autoloader
require __DIR__ . '/vendor/autoload.php';

use Hapio\Sdk\ApiClient;

// Instantiate a Hapio API client
$apiClient = new ApiClient('your-api-token');

// Get a list of all bookings this week
$response = $apiClient->bookings()->list([
    'from' => new DateTime('monday this week 00:00:00'),
    'to' => new DateTime('friday this week 23:59:59'),
]);

while ($response) {
    foreach ($response->getItems() as $booking) {
        var_dump($booking);
    }

    if ($response->hasMoreItems()) {
        $response = $response->getNextPage();
    } else {
        $response = null;
    }
}

Documentation et modèles

Le SDK Hapio pour PHP offre une documentation complète et inclut différents modèles pour interagir efficacement avec l'API Hapio. Voici quelques-uns des modèles disponibles :

  • Projet
  • Localisation
  • Ressources
  • Service
  • ScheduleBlock
  • Calendrier récurrent
  • RecurringScheduleBlock
  • Réservation
  • Emplacement réservé
  • Intervalle de temps
  • ResourceServiceAssociation

Ces modèles simplifient l'interaction avec les entités Hapio, facilitant la création, la mise à jour et l'extraction de données. Les développeurs peuvent définir des propriétés et interagir avec les modèles en utilisant les conventions de nommage snake_case ou camelCase.

Référentiels

Pour faciliter la communication avec l'API, le SDK Hapio pour PHP fournit des classes de dépôt pour chaque type d'entité disponible dans Hapio. Ces référentiels servent de passerelles pour envoyer et récupérer des données et sont accessibles par des méthodes de la classe ApiClient.

Voici quelques-uns des référentiels disponibles :

  • Dépôt de projet
  • Référentiel de localisation
  • Référentiel de ressources
  • ServiceRepository
  • ScheduleBlockRepository
  • RecurringScheduleRepository
  • RecurringScheduleBlockRepository (référentiel de blocs)
  • Référentiel de réservation

Chaque référentiel propose un ensemble de méthodes correspondant aux points d'accès de l'API disponibles pour le type d'entité concerné.

Réponses paginées

Pour les points de terminaison de l'API qui renvoient des listes de données paginées, le SDK Hapio fournit une classe PaginatedResponse avec diverses méthodes pour simplifier le traitement de ces réponses. Les développeurs peuvent facilement naviguer dans les données paginées, récupérer des éléments et déterminer s'il y a d'autres pages disponibles.

Traitement des exceptions

Le SDK Hapio pour PHP inclut une gestion robuste des exceptions, garantissant aux développeurs une gestion efficace des erreurs. Lorsque l'API répond avec des codes de statut 4XX ou 5XX, les exceptions appropriées sont lancées. Les erreurs de validation avec un code de statut 422 déclencheront une ValidationException, tandis que les autres codes de statut 4XX et 5XX entraîneront une ErrorException. Ces exceptions permettent d'accéder aux messages d'erreur, aux codes d'état et aux erreurs de validation, le cas échéant.

Avec la sortie du SDK Hapio pour PHP, les développeurs peuvent désormais intégrer de manière transparente les capacités de réservation et de planification de Hapio dans leurs projets PHP, améliorant ainsi l'efficacité et la fonctionnalité de leurs applications.

Le SDK est disponible sur Packagist.org, prêt à être installé via Composer. Vous pouvez également consulter le code source sur GitHub.

Auteur

Jesper