Overview

Welcome to the Ziflow API

The Ziflow API is built to allow you to easily and quickly embed Ziflow’s proofing features in your own application or create an integration between Ziflow and any other application. This API is the same one we use to power Ziflow!

The API is a RESTful interface, essentially providing programmatic access to the features and data in the system. If you’ve interacted with a RESTful API before, many of the concepts will be familiar - it provides predictable URLs for accessing resources and uses built-in HTTP features. API calls to Ziflow should be made to the https://api.ziflow.io base domain

The API accepts JSON or form-encoded content in requests and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.

Security & Authentication

The Ziflow API is an SSL-only API. You must be a verified user to make API requests. Ziflow currently supports basic authentication using an API token. The API token can be found on your “Contact details” page - you can access this page by clicking on your avatar in the top right when logged in to the application.

Use the following authentication formats with the API token:

HTTP Basic Authentication:

1. Simple example:

Most client software provides a simple mechanism for supplying a user name and password (or API token). For example you can specify the -u argument with cURL. You would provide the API key and supply "X" as the password:

curl -u {api_key}:X -H Accept:application/json -X GET https://{subdomain}.ziflow.io/v1/proofs

 

2. Supplying basic authentication headers

BASE64 encode the API key and supply an Authorization header with content Basic followed by the encoded string:

curl -H " {api_key_base64_encoded} -H Accept:application/json -X GET https://{subdomain}.ziflow.io/v1/proofs

 

3. Supplying a URL parameter

https://api.ziflow.io/v1/proofs/?apikey=api_key