Parsequerade / docs
Get started

Getting started

Quickstart

Follow a proposed read flow from an app list to one explicitly selected version and locale.

Status

Proposed The service is not implemented. asc.example.com and the IDs below are placeholders; these commands describe the planned contract and will not reach an available Parsequerade service.

Prepare access

Set ASC_FACADE_KEY to a facade API key issued for a configured connection. The service would use that connection’s Apple credentials on the caller’s behalf; clients would not create Apple JWTs.

Requests use this connection-scoped base URL:

Shell
BASE='https://asc.example.com/v1/connections/conn_example'

1. List apps

Start with a bounded page. Narrow the list with a supported filter such as bundleId when you know it.

cURL
curl --fail-with-body "$BASE/apps?limit=50" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

curl --fail-with-body "$BASE/apps?bundleId=com.example.app&limit=50" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

The collection response would contain plain objects in items and an opaque nextCursor. Select the intended app ID from the result; the service does not choose the first match for you.

2. Select a version

Use the app ID from the list, then choose the returned version ID that matches the platform and state you intend to read.

cURL
curl --fail-with-body \
  "$BASE/apps/1234567890/versions?platform=IOS&state=PREPARE_FOR_SUBMISSION" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

Replace 1234567890 with an app ID you received. The state filter is explicit; no draft-to-live fallback is implied. See List versions for its proposed response fields.

3. Read an exact locale

Use the selected version ID and the exact locale you need. This example reads en-US from version_123.

cURL
curl --fail-with-body \
  "$BASE/apps/1234567890/versions/version_123/localizations/en-US" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

The route resolves that locale under the selected version and returns one flat object. If the exact locale does not exist, the planned response is 404 localization_not_found; request another locale or use the version-localizations collection to inspect available locales. It does not substitute the primary locale.

See Read a version localization for the response shape.