Proof Sharing

Share a proof

Proofs can be shared to external users outside the project for commenting. Sharing creates a personal link to the proof, linked to the guest user’s email address. Guest users will not see any other project information and will not be able to log in to Mediabank.

There are two options to share the proof to quests:

The share URL can be shared using the email invite sent by the system.
The share URL can be fetched from the response and shared in desired way.

Request : /papi/v1/proof/share

Parameter	Parameter Type	Mandatory	Description
Share Object	Body	yes	Proof share object. Check the share data model definitions from the swagger documentation https://grano.emmi.fi/papi/v1/swagger/ui/index#!/Project/POST_proof_share
x-auth-token	Header	yes	The authentication token must be provided as an x-auth-token header for every API request. More information about authentication token.

Response: JSON – Share object.

{
    "ProofId": "321",
    "ProofStatusId": "4",
    "Guests": [
        {
            "Name": "Average Guest",
            "Email": "average.person@mail.com",
            "IsOpinionAllowed": true,
            "SendEmailInvitation": false,
            "IsActive": true,
            "ShareUrl": "https://[EMMi instance]/l/B897AYu3uWYh",
            "VersionIds": [
                "1234"
            ],
            "AccessCount": 0,
            "Invited": 1657884503,
            "Response": "Pending",
            "CommentCount": 0
        }
    ],
    "IsCancelled": false
}

cURL Examples

Sharing proof by sending the invite via email.

curl --location --request POST 'https://[EMMi instance]/papi/v1/proof/share' \
--header 'x-auth-token: [Session token]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ProofId": "321",
    "ProofStatusId": "4",
    "Guests": [
        {
            "Name": "John Average",
            "Email": "john.average@mail.com",
            "IsOpinionAllowed": true,
            "SendEmailInvitation": true,
            "IsActive": true
        },
        {
            "Name": "Mary Mediocre",
            "Email": "mary.mediocre@mail.com",
            "IsOpinionAllowed": true,
            "SendEmailInvitation": true,
            "IsActive": true
        }
    ],
    "EmailMessageContent": "Hi,\n\nHere is a layout for you to review.\n\nCreated by Proof Integration",
    "EmailLanguageCode": "en",
    "IsCancelled": false
}'

Email invite created by the request

The inviter name and email is from the API user who created the invite.

Proof Integration (integration@mail.com) invited you to comment a proof in Grano project management.

PROOF DETAILS:
Proof name: New_amazing_catalog_128pages

MESSAGE FROM Project Management
Hi,

Here is a layout for you to review.

Created by Proof Integration

You can accept or decline the invitation using this link:
https://[EMMi instance]/l/B897AYu3uWYh
This is your unique link to shared proof. Please keep in mind, that if you share this link forward, others can access the proof as you.

Sharing proof without sending an email invite.

 curl --location --request POST 'https://[EMMi instance]/papi/v1/proof/share' \
--header 'x-auth-token: [Session token]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ProofId": "321",
    "ProofStatusId": "4",
    "Guests": [
        {
            "Name": "John Average",
            "Email": "john.average@mail.com",
            "IsOpinionAllowed": true,
            "SendEmailInvitation": false,
            "IsActive": true
        },
        {
            "Name": "Mary Mediocre",
            "Email": "mary.mediocre@mail.com",
            "IsOpinionAllowed": true,
            "SendEmailInvitation": false,
            "IsActive": true
        }
    ],
    "IsCancelled": false
}'

Cancel sharing for one user

 curl --location --request POST 'https://[EMMi instance]/papi/v1/proof/share' \
--header 'x-auth-token: [Session token]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ProofId": "321",
    "Guests": [
        {
            "Email": "average.person@mail.com",
            "IsActive": false
        },
        {
            "Email": "mediocre.person@mail.com",
            "IsActive": true
        }    
    ]
}'

Get share information

Request : GET papi/v1/proof/[Proof Id]/share

Function for getting the sharing Information of a shared proof.

Parameter	Parameter Type	Mandatory	Description
Proof Id	Path	yes	Unique proof id.
x-auth-token	Header	yes	The authentication token must be provided as an x-auth-token header for every API request. More information about authentication token.

Response: JSON – Share object.

cURL example

curl --location --request POST 'https://[EMMi instance]/papi/v1/proof/[Proof Id]/share \
--header 'x-auth-token: [Session token]'

Get list of proof statuses

Get Conversations

Feedback

Post your comment on this topic.