Under de senaste veckorna har vi arbetat med ett SDK för PHP, för att göra det enklare för PHP-utvecklare att komma igång med Hapio. Vi är nu glada att meddela att det släpps publikt.
Hapio SDK för PHP är utformad för att effektivisera integreringen av Hapiios robusta boknings- och schemaläggningsfunktioner i PHP-applikationer, vilket ger utvecklare ett kraftfullt verktyg för att förbättra funktionaliteten i sina projekt.
Systemkrav
Innan utvecklare börjar använda Hapio SDK för PHP bör de säkerställa att deras miljö uppfyller följande krav:
PHP 8.2 eller senare.
Komma igång
Att integrera Hapio SDK i ett PHP-projekt är en enkel process. Utvecklare kan använda Composer, en populär PHP-beroendehanterare, för att inkludera SDK:et i sitt projekt. Så här kommer du igång:
Öppna projektets terminal eller kommandotolk.
Kör följande Composer-kommando:
shell
composer require hapio/hapio-sdk-php
När SDK:et har installerats kan utvecklare börja använda det i sina projekt.
Arbeta med SDK:et
Att använda Hapio SDK för PHP är lika enkelt som att instansiera en API-klient och sätta igång. Nedan följer ett exempel på hur du kommer igång med SDK:et:
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;
}
}
Dokumentation och Modeller
Hapio SDK för PHP erbjuder omfattande dokumentation och innehåller olika modeller för att interagera effektivt med Hapio API. Några av de tillgängliga modellerna inkluderar:
- Projekt
- Plats
- Resurs
- Tjänst
- Schemaläggningsblock
- ÅterkommandeSchema
- ÅterkommandeSchemablock
- Bokning
- BokningsbarTid
- Tidsperiod
- ResursTjänstAssociation
Dessa modeller förenklar interaktionen med Hapio-enheter och gör det lättare att skapa, uppdatera och hämta data. Utvecklare kan ställa in egenskaper och interagera med modellerna med hjälp av antingen snake_case eller camelCase namngivningskonventioner.
Förvar
För att underlätta kommunikationen med API:et tillhandahåller Hapio SDK för PHP lagringsklasser för varje typ av enhet som finns tillgänglig i Hapio. Dessa repositories fungerar som gateways för att skicka och hämta data och är tillgängliga via metoder i ApiClient-klassen.
Några av de tillgängliga arkiven inkluderar:
- ProjektRepository
- PlatsRepository
- Resursförvar
- Förvar för tjänster
- SchemaBlockRepository
- RecurringScheduleRepository
- RecurringScheduleBlockRepository
- Bokningsförvaring
Varje arkiv erbjuder en uppsättning metoder som motsvarar de tillgängliga API-slutpunkterna för respektive entitetstyp.
Paginerade svar
För API-slutpunkter som returnerar paginerade listor med data tillhandahåller Hapio SDK en PaginatedResponse-klass med olika metoder för att förenkla hanteringen av dessa svar. Utvecklare kan enkelt navigera i paginerad data, hämta objekt och avgöra om det finns fler sidor tillgängliga.
Hantering av undantag
Hapio SDK för PHP innehåller robust undantagshantering, vilket säkerställer att utvecklare kan hantera fel på ett effektivt sätt. När API:et svarar med 4XX- eller 5XX-statuskoder kastas lämpliga undantag. Valideringsfel med en statuskod på 422 kommer att utlösa ett ValidationException, medan andra 4XX- och 5XX-statuskoder resulterar i ett ErrorException. Dessa undantag ger tillgång till felmeddelanden, statuskoder och valideringsfel i tillämpliga fall.
Med lanseringen av Hapio SDK för PHP kan utvecklare nu sömlöst integrera Hapios boknings- och schemaläggningsfunktioner i sina PHP-projekt, vilket förbättrar effektiviteten och funktionaliteten i deras applikationer.
SDK finns tillgängligt på Packagist.org, redo att installeras via Composer. Du kan också kolla in källkoden på GitHub.