In your app
A controller answers a route on your app: it callsgetBlogLocales() and returns the answer.
Add the controller
app/Http/Controllers/GetBlogLocalesController.php
Add the route
routes/web.php
Call it
Terminal
php artisan serve running, it prints its answer as JSON.Call it from the terminal
Terminal
getBlogLocales() 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
$row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).
Required parameters
Required parameters
Returns
Returns
Errors
Errors
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
The site refused what was sent:
errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().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().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().Nothing matches, or the caller may not see it.Retried first: No. Read:
siteMessage(), errorName(), data().The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read:
siteMessage(), errorName(), data().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().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 status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason(), status().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.Behavior
- Access: an API key with
content:blog:read(or a master above it:content:blog:all,content:all,admin:all) reads the published documents; drafts (a draft_id) needcontent:blog:write(or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields. - 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 seeRateLimitedonly 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
timeoutinconfig/fetchski-attract.phpfor 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 astests/Feature/GetBlogLocalesTest.php, then run your tests:
tests/Feature/GetBlogLocalesTest.php
Terminal
Related
Get the Markdown template
Attract::blogPosts()->getBlogMarkdownTemplate()Get the MDX template
Attract::blogPosts()->getBlogMdxTemplate()List blog posts
Attract::blogPosts()->listBlogs()Create a blog post
Attract::blogPosts()->createBlog()Get a blog post
Attract::blogPosts()->getBlog()Replace a blog post
Attract::blogPosts()->replaceBlog()GET /@apostrophecms/blog/{_id}/locales
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.