DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

==== Web Service: StoreChecksum ====

The StoreChecksum web service is used to store the checksum value of a Base64 string contained in a CeRTNA Standard XML PRIA_DOCUMENT node. The checksum value that is passed to the StoreChecksum web service is the SHA384 calculated binary checksum that has been converted to a Base64 string.

The StoreChecksum web service, returns a checksum key. The checksum key is the value that should be stored in either the RequestChecksumValue (agents) or ResponseChecksumValue(counties) property of the PRIA_DOCUMENT node, depending on who made the StoreChecksum request.

The following sample shows the checksum key stored in PRIA_DOCUMENT node:

The checksum key is used in the ValidateChecksum web service to facilitate the process of validating a checksum value that was stored by another party.

<color #7092be>Request Endpoint</color>

{{tablelayout?colwidth="100px,500px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Method ^ URL ^
| POST | <nowiki>https://apex-prd.certna.org/storechecksum</nowiki> |

<color #7092be>Request Body</color>

This endpoint accepts request body parameters using an application/json format.

<color #7092be>Request Headers</color>

{{tablelayout?colwidth="150px,450px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Key ^ Value ^
| Content-Type | application/json |

<color #7092be>JSON Request Parameters</color>

{{tablelayout?colwidth="150px,75px,100px,275px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Parm Name ^ Req/Opt ^ Format ^ Description ^
| checksum | Required | [string] | Locally calculated binary checksum value converted to a Base64 string. |

<color #7092be>JSON Response Parameters</color>

{{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Parm Name ^ Format ^ Description ^
| checksum_key | [string] | The key of the checksum record that was stored in the CeRTNA Portal. |
| code | [string] | Exception conditions will result in code/message being returned. |
| message | [string] | Longer description of exception condition. |

As noted, any condition that results in an unsuccessful call to the StoreChecksum web service will produce a JSON formatted response with a code and message property populated. Successful calls will result in the checksum_key property being returned. The checksum_key is a required parameter of the ValidateChecksum web service.

<color #7092be>Sample Request</color>

**Endpoint:**

<nowiki>https://apex-prd.certna.org/storechecksum</nowiki>

**Headers:**

Content-Type: application/json

**Body:**

<code json>
{
  "checksum" : "1/l1YnJ1dnWFVbjEcUfp3IkBkPb1XBWhdC34T6nJ3YB859YuAtbhUUEG8Gcwimd1"
}
</code>

**Sample Response:**

Status Code: 200

or

Status Code: 500  (When an error occurs.)

<code json>
{
    "checksum_key": "315E7449-1A67-44A8-BCF4-7EB43666D54D"
}
</code>

or  (example 1)

<code json>
{
    "Exception": {
        "Code": "DatabaseError",
        "Message": "Procedure or function 'spStoreChecksumValue' expects parameter '@CHECKSUM_VALUE', which was not supplied."
    }
}
</code>

<color #7092be>Additional Comments</color>

Comments and sample code are provided for reference purposes only and are not intended to show all exception handling conditions and/or completed code blocks.

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International