The zkcloud api is build on HTTP. Our API is RESTful Api.
All API calls referenced in our documentation start with a base URL.It’s also important to note that our platform uses URI versioning for our API endpoints,
Our base URL is:
Please keep it in a safe place so that it will not be published. If you don't need to use api keys, delete the api keys in the settings paes.
Authentication to the API is performed via bearer auth. use
To test requests using your account, replace the
<API_TOKEN>with your actual API key.
curl -H "Authorization: Bearer <API_TOKEN>"
We adopt media Type Versioning uses the
Acceptheader of the request to specify the version. You add
v=1on the headers to request all apis.
curl -H "Accept: application/json;v=1" -H "Authorization: Bearer <API_TOKEN>" http://localhost:4000/proofs
'Sun, 03 Oct 2021 14:02:46 GMT'
HTTP response status codes indicate whether a specific HTTP request has been successfully completed.
Error Reponse format is following.
Error type means the type of errors in the server. Message means actual error message.