Read a design as its customer reviews it
const url = 'https://api.pixonaut.app/v1/designs/example/review';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.pixonaut.app/v1/designs/example/review \ --header 'Authorization: Bearer <token>'Operation ID: designs.review.get
Where the design stands, whether its proof still shows it, and any open request for changes. Never the design’s document or its fulfilment payload.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The design’s review
object
When a scheduled approval falls due, or null.
Whether the caller may approve, reject or ask for changes: a secret key, or a proof page link the tenant handed the decision to.
The open request for changes a customer made on the design’s proof page, or null. Open while the design awaits approval at the version it was about; correcting or deciding the design closes it.
object
Whether the design has a proof image to show.
Whether the design has a proof and it shows what the design says now. Each correction renders a proof of its own; a design corrected before that was so has only its first proof. A customer decides the design from its proof page only when this is true.
Why the design was rejected, as the shop said, for its customer to read; null when it is not rejected, or was rejected without a reason.
Examples
Example
{ "approveAfter": 1792022400000, "canDecide": true, "changeRequest": { "message": "Please change the name to Alexandra L.", "requestedAt": 1791766800000 }, "hasProof": true, "id": "6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c", "proofIsCurrent": true, "rejectionReason": null, "revision": 2, "status": "committed"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, secret_key_required, feature_disabled, forbidden
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}forbidden
{ "error": "forbidden"}origin_forbidden
{ "error": "origin_forbidden"}secret_key_required
{ "error": "secret_key_required"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: not_found
object
Examples
not_found
{ "error": "not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: rate_limited
object
Examples
rate_limited
{ "error": "rate_limited"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].