Aller au contenu
Livstick Développeurs

Get the printed card

Méthode GET https://<client-api-host>/api/v3.1/containers/{crid}/card

PDF card for the container, rendered from the platform PDF template with the QR code of the public link. The printed identifier is the crid.

Autorisation

Scope requis containers:card

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Paramètres

Nom Emplacement Type Requis Contraintes Description
crid Chemin string Requis Your business reference of the container.

Réponses

200 application/pdf

PDF document.

400 application/json Schéma V31ErrorEnvelope

Invalid payload, unknown field or invalid value.

401 application/json Schéma V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schéma V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403
{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

404 application/json Schéma V31ErrorEnvelope

Container not found for this crid on the platform of the key.

json 404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Container not found"
  }
}

429 application/json Schéma V31ErrorEnvelope

Rate limit exceeded.

json 429
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schéma V31ErrorEnvelope

Unexpected server error.

json 500
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}

502 application/json Schéma V31ErrorEnvelope

The card renderer failed (CARD_RENDERER_FAILED).

json 502
{
  "error": {
    "code": "CARD_RENDERER_FAILED",
    "message": "Card rendering failed"
  }
}

503 application/json Schéma V31ErrorEnvelope

The card renderer is unavailable (CARD_RENDERER_UNAVAILABLE).

json 503
{
  "error": {
    "code": "CARD_RENDERER_UNAVAILABLE",
    "message": "Card renderer unavailable"
  }
}