Skip to main content

In your app

A controller answers a route on your app: it calls getMediaImage() and returns the answer.

Add the controller

app/Http/Controllers/GetMediaImageController.php

Add the route

routes/web.php

Call it

Terminal
With php artisan serve running, it prints its answer as JSON.
To keep the call in an Action instead, this writes app/Actions/Attract/GetMediaImage.php (an invokable Action that calls getMediaImage()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

Terminal
It calls getMediaImage() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type.

Required parameters

Named arguments, e.g. getMediaImage(id: …); leave out the optional ones.
string
required
Required. The image’s document ID, its slug, or its exact title (case-insensitive), tried in that order.
A MediaImage (Fetchski\AttractCmsLaravel\Data\MediaImage). One image from the Images library. Read its properties ($mediaImage->id): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, two-thirds → twoThirds, one-half → oneHalf …).
?string
Always sent, can be null. The image’s document ID (aposDocId).
?string
Always sent, can be null. Reference an image in an MDX import by it.
?string
Always sent, can be null. Its title.
string
Always sent. Alt text; empty when none is set.
?string
Always sent, can be null. The media folder it sits in.
?int
Always sent, can be null. Pixels.
?int
Always sent, can be null. Pixels.
?string
Always sent, can be null. File extension, e.g. jpg.
?int
Always sent, can be null. Size of the original file.
MediaImageUrls
Always sent. A MediaImageUrls. A URL per rendered size.
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
400
The request is not valid.Retried first: No. Read: errors() (field → messages), siteMessage().
401
The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage(), errorName(), data().
403
The API key lacks the scope this route needs, is used from outside its allowlist, or the caller is anonymous.Retried first: No. Read: siteMessage(), errorName(), data().
404
Nothing matches the identifier.Retried first: No. Read: siteMessage(), errorName(), data().
429
The key used up its reads-per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter() (seconds, or null), siteMessage().
5xx
The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage(), errorName(), data().
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason(), neverConnected().
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().
setup
Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.
setup
The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

  • Access: an API key with images:read — or media:all, or admin:all — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403.
  • Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
  • Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

More examples

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/GetMediaImageTest.php, then run your tests:
tests/Feature/GetMediaImageTest.php
Terminal
Answer with your own values: fake fetchskiMedia.getMediaImage with MediaImage::factory()->make([...]), the fields you give over a valid example.
tests/Feature/GetMediaImageAnswerTest.php

List images

Attract::fetchskiMedia()->listMediaImages()

List videos

Attract::fetchskiMedia()->listMediaVideos()

Get one video

Attract::fetchskiMedia()->getMediaVideo()

GET /fetchski-media/images/{id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.