/share (GET)

The API will allow you to generate a new share and retrieve the share link for that file. Call the Files with the /share route, i.e. https://api.cargosnap.com/api/v2/share

Parameters

reference required (max 255)

The used file reference, as a string. This represents the barcode (scan code) value used in the barcode scanner, as well as the value used on the platform. Example value: reference=76543234567

customer_reference optional (max 255)

The customer reference, as a (URL encoded) string. This represents the reference or identifier that the recipient uses for your file. Typically, a customer order reference or a common B/L number. Using this reference provides a great service for your customer, as it's a reference they recognise (while the reference above is typically your internal reference). Example value: customer_reference=12344321

expires optional

A date/time field indicating when the share should expire. Upon expiration, the link will no longer be valid. If not supplied, the share will never expire. The date/time format must be ISO-8601, and the time zone should be UTC. The time field is optional; we will assume the start of the day in the UTC time zone. Example value: expires=2017-03-01

language optional

A supported language as an ISO 639-1 2 letter code. Sets the language of the shared file view. If not supplied, or invalid, the API defaults to the language setting of the location the reference belongs to. Example value: language=fr

dl optional

The DL reference, as defined in Cargosnap. This allows a share being created for multiple recipients in 1 call. This is best used for sharing between companies, where we suggest the used dl reference corresponds to the customer reference id in the host system (WMS/TMS). Example value: dl=1234abc

email optional

The email address of the recipient of the share. Example value: email=example@cargosnap.com

send_email optional (default = true)

If set to “false”, there will be no email send to the email recipient. This is handy if you want to send the sharing mail yourself.

All response values are provided as string values, and are appropriately escaped. The API will respond with a "Cache-Control=no-cache" header always.

Response values

String, with value either "success" or "error"

status (string)

describing detailed (error) information.

share_url Unique URL of the Cargosnap device, used to take the image.

Example Request

GET /api/v2/share
?token=NjJPV25wcXZwV3pjRkFr****************
&reference=351606436
&expires=28-09-2017
&timezone=UTC
&language=en
&username=Cargosnap (optional, def=system api token)
URL: https://api.cargosnap.com/api/v2/share

For example, one may issue: GET https://api.cargosnap.com/api/v2/share?reference=123456789&token=MY-API-TOKEN&lang=en

curl --request GET \
  --url 'https://api.cargosnap.com/api/v2/share?reference=123456789&token=MY-API-TOKEN&lang=en'

Example result for a call like: https://api.cargosnap.com/api/v2/share?token=************==&reference=testgg

Header: 200 SUCCESS
{
"response":"success",
"status":"SHARE CREATED",
"share_url":"https:\/\/platform.cargosnap.com\/shared_files?token=fB4djl9x5nYZ3W*******&email=api_11294&l=en"
}

Header: 401 NOT AUTHORIZED
{
"response":"error",
"status":"Unauthorized"
}

Header: 404 FILE NOT FOUND
{
"response":"error",
"status":"NO FILE FOUND"
}

Header: 422 
{
"response":"error",
"status":"INVALID TIMEZONE"
}