Permalink Service (1.0)

Download OpenAPI specification:Download

Team Web Platform: team-web-platform@newstore.com URL: https://backstage.p.newstore.io/catalog/default/group/team-web-platform

An HTTP API for creating public references to file objects in the shared AWS S3 bucket. The bucket is only accessible from the shared VPCs.

create-link

Resource to create public links to documents.

Creates a link to allow access to a document stored in S3

Use this method to create a permalink that will redirect the user to a document stored in S3 using a presigned S3 URL. This permalink can then be shared publicly.

header Parameters

Tenant

required

string (Tenant)

Request Body schema: application/json

service required	string The name of the calling service, e.g. `templates` or `delivery`
entity required	string The entity of the documents, e.g. `templates_documents` or `shipment_label`
filename required	string The filename of the document, e.g. `invoice_{uuid}.pdf`
subentity	string The subentity of the document, e.g. `invoice` or `label_url`

Responses

Request samples

Payload

Content type

application/json

{"service": "string",
"entity": "string",
"filename": "string",
"subentity": "string"
}

Response samples

200
400
500

Content type

application/json

{"permalink": "string"
}

show-document

Retrieves the link document

Retrieves information about a reference

Use this method to retrieve information about the specified UUID via the permalink service, with all information about the reference.

path Parameters

uuid

required

string <uuid> (uuid identifying the document)

header Parameters

Tenant

required

string (Tenant)

Responses

Response samples

200
400
404
500

Content type

application/json

{"service": "string",
"entity": "string",
"filename": "string"
}