Skip to main content
The collection is generated from the OpenAPI specification and holds all 16 endpoints of the API.

Fork it in Postman

The collection on the Postman API Network. Fork it to get its updates.

Download the collection

proofage-api.postman_collection.json, to import by hand.

Import

  1. Fork the collection from ProofAge’s Postman profile, or choose Import in Postman and drop the downloaded file into the dialog.
  2. Open the collection’s Variables tab. baseUrl is already set to https://api.proofage.net/v1. Fill in the other two, in the Current value column so your keys are not synced to your team:
Every request is now signed when you send it. Start with Get workspace configuration: a 200 means the keys and the signature are right, a 401 means one of them is not.

How requests are signed

Every request needs X-API-Key and X-HMAC-Signature (see API authentication). The collection’s pre-request script adds both. This is the script it runs:
A media upload is signed over its form fields and the SHA-256 of each file, which a pre-request script cannot read, so the script leaves uploads unsigned. Upload media with a server SDK or the signing code in API authentication.

Next steps