Skip to main content

In your app

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

Add the controller

app/Http/Controllers/GetVideoLocalesController.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/GetVideoLocales.php (an invokable Action that calls getVideoLocales()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

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

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.
Laravel
Terminal
Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. getVideoLocales(id: …); leave out the optional ones.
string
required
Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).
A DocumentLocales (Fetchski\AttractCmsLaravel\Data\DocumentLocales). The locales the document exists in. Read its properties ($documentLocales->results): each says whether the site always sends it.
Collection<int, array<string, mixed>>
Always sent. One entry per locale the document exists in.
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
400
The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().
401
The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().
403
The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().
500
The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). 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 content:videos:read (or a master above it: content:videos:all, content:all, admin:all) reads the published documents; drafts (a draft _id) need content:videos:write (or a master above it). A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
  • Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • 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.

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/GetVideoLocalesTest.php, then run your tests:
tests/Feature/GetVideoLocalesTest.php
Terminal

List videos

Attract::videos()->listVideos()

Create a video

Attract::videos()->createVideo()

Get a video

Attract::videos()->getVideo()

Replace a video

Attract::videos()->replaceVideo()

Delete a video

Attract::videos()->deleteVideo()

Update a video

Attract::videos()->updateVideo()

GET /video/{_id}/locales

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