oilstone / api-contentful-integration

v1.2.0 2025-10-29 16:49 UTC

Requires

• contentful/contentful: ^7.1
• contentful/contentful-management: ^5.1
• contentful/rich-text: ^4.0
• garethhudson07/aggregate: ^1.2
• garethhudson07/api: ^9.5
• nesbot/carbon: ^3.10

Requires (Dev)

• guzzlehttp/guzzle: ^7.9
• laravel/framework: ^11.0
• oilstone/api-resource-loader: ^5.3
• psr/http-message: ^1.0

MIT

• Brendan Bullen

Published on Packagist.org on 2025-10-29 16:50 UTC

README

A Contentful integration package for garethhudson07/api

System status monitor

With oilstone/system-status installed, the service provider registers a contentful monitor type that checks a configured space can be reached with its credentials:

composer require "oilstone/system-status:^2.0.0-beta.3"

Option	Purpose
api	delivery (default), preview or management
context	A key of contentful.environments to check instead of the default space
name	Replaces the default name, "Contentful {Api}", or "Contentful {Api} ({context})" with a context
timeout, connect_timeout, options	Guzzle settings, as for any monitor using MakesHttpRequests (defaults 5 and 3 seconds)
thresholds, otherwise	Response time ratings (default under 1000ms optimal, under 3000ms acceptable)

The Delivery and Preview APIs are checked by fetching the environment's locales, and the Management API by fetching the environment. Results include the space and environment metadata, plus the number of locales for Delivery and Preview.

A context's token, space and environment are used only when that context has a token for the API being checked. Otherwise the default space's contentful.{api}.token, contentful.space and contentful.environment are, the same rule the package's clients follow. The environment defaults to master. An unknown api or context, or a blank token or space, fails when the monitor is built, naming the config keys to set. A context is checked directly, whether or not contentfulContext is set or contextAware is on.

The monitor builds its own clients, so its responses are never cached, and the request's locale and contentful.debug logging don't apply.

Add it to system-status.monitors:

'monitors' => [
    'services' => [
        ['type' => 'contentful'],
        ['type' => 'contentful', 'api' => 'management', 'timeout' => 10],
        ['type' => 'contentful', 'context' => 'europe'],
    ],
],

Or use it as a watch's monitor:

'watches' => [
    'definitions' => [
        'contentful' => [
            'monitor' => ['type' => 'contentful', 'api' => 'delivery'],
            'failures' => 3,
            'handler' => App\Watches\ServeCachedContent::class,
        ],
    ],
],