Generate anonymous authentication guid for proof API endpoint

Generate anonymous authentication guid for proof API endpoint

POST/api/QuoteProcess/GenerateAnonymousAuthenticationGuidForProof?LoginToken={{LoginToken}}

Description

This endpoint generates an anonymous authentication GUID for proof. Along with the Login Token obtained from the GetLoginToken endpoint, a valid Contact ID (ccID) and a list of Proof Keys (PPKeys) must be provided in the payload.

Request Payload

{
  "PPKeys": [
    0
  ],
  "ccID": 0
}

Parameters

  • LoginToken (string): The token obtained from the GetLoginToken endpoint.
  • PPKeys (array of integers): A list of proof keys. At least one proof key must be provided.
  • ccID (integer): A valid contact ID associated with the job's customer.

Responses

Error Response

If the provided payload is invalid, a response with an error message will be returned. Below is an example:

{ "AAGuid": "00000000-0000-0000-0000-000000000000", "ProofDetailsUrl": null, "ProofDetails": null, "ErrorMessage": "The 'ccID' field is required and must be a valid contact associated with the job's customer", "IsError": true, "WarningMessage": null, "IsWarning": false }


Possible error scenarios include:

  • Omission of ccID or PPKeys
  • Invalid ccID (e.g., a contact not associated with the job the proof is on)
  • PPKeys from different acceptances
  • Invalid or modified GUID

Success Response

If the request is valid, a successful response will look like this:

{ "AAGuid": "8153284d-385a-43c5-b1d2-a31f57dfb48b", "ProofDetailsUrl": "https://test.printiq.com/ProofDetails.aspx?PPGuid=efb4c031-4c0d-41b3-8dd1-d166574a3ac7&Guid=8153284d-385a-43c5-b1d2-a31f57dfb48b", "ProofDetails": [ { "PPGuid": "efb4c031-4c0d-41b3-8dd1-d166574a3ac7", "ProofDetailsUrl": "https://test.printiq.com/ProofDetails.aspx?PPGuid=efb4c031-4c0d-41b3-8dd1-d166574a3ac7&Guid=8153284d-385a-43c5-b1d2-a31f57dfb48b" } ], "ErrorMessage": null, "IsError": false, "WarningMessage": null, "IsWarning": false }


Workflow

  1. Validation: The system validates the provided ccID and PPKeys.
  2. Error Handling: If validation fails, an appropriate error message is returned.
  3. GUID Generation: If validation succeeds, a GUID is generated and returned.
  4. Proof Detail URL: The proof detail URL can then be collected and sent to the client.





    • Related Articles

    • Save Quote Question endpoint

      Where to get the Value of SaveQuoteQuestion Endpoint? If you are experimenting on how to run POST Method to SaveQuoteQuestion Endpoint. You can use this method to check the Payload required. Console --> Network Tab --> Check Arrow Using this example, ...

    • API – Single Sign On

      INTRODUCTION The printIQ Single Sign On (SSO) API can be called to obtain a URL with a token that has been pre-authenticated to log a user in, and begin a customer quote. The API calls are restricted by IP address, which must be configured manually ...

    • API – QuoteProcess Creating a Basic Quote

      Basic API calls to create a quote/job Each printiq instance site has access to the Swagger API doco https://{instancedetail}/swagger/ui/index To build a basic quote – in order the calls would be : ...

    • API - Creating Tax Code and Tax Rates in printIQ

      Overview The purpose of this document is to assist with retrieving and creating TaxCodes and TaxRates within printIQ. API Request Table Below is a list of endpoints used for retrieving, updating, and creating TaxCodes and TaxRates API Object Odata ...

    • Add External Consignment

      How to use this endpoint You can add an Consignment in IQ via AddExternalConsignments Endpoint. /api/QuoteProcess/AddExternalConsignment Required payload to Postback to AddExternalConsignment Endpoint { "ExternalConsignment": { "ConsignmentNo": ...