Resolve a path

GET

/content/delivery/v1/path/{path}

const url = 'https://api.ebitex.io/content/delivery/v1/path/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/content/delivery/v1/path/example \
  --header 'Authorization: Bearer <token>'

Returns whatever is published at a path. kind says what you got:

presentation: a page, with its Template, settings and bound component, plus the page’s title and titleSource.
redirect: follow targetPath yourself. Chains are collapsed server-side, and a renamed page’s old path answers with a redirect to the new one.

Name the site with site (a root node id from /sites) or host (the hostname you serve the page under). On a site with locale addressing the locale comes from the address, so locale= is refused. resolve sets how many levels of references are expanded into content, and ctx carries the visitor context used for personalization.

With an X-Ebitex-Preview-Session header, the page being previewed answers with its draft and X-Ebitex-Preview: draft; every other path answers what is published.

Key: a delivery key (content.delivery.read).

Authorizations

apiKey

Parameters

Path Parameters

path

required

string

Query Parameters

site

string format: uuid

host

string

locale

string

resolve

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

raw

boolean

ctx

string

include

Array<string>

Responses

200

400

locale_not_addressable: the site takes its locale from the address. validation_failed: an unsupported parameter value. preview_raw_unsupported: raw=true with a preview session.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

403

preview_site_mismatch: the path is in a different site from the page being previewed.

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

404

path_not_found: nothing is published at this path. site_not_found: no site matches site or host.

429

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.