Zigaflow has API's that allow you to:
- Create Leads/Opportunities (called Pipeline Items)
- List Quotes
- Get top-level Quote Details
- List, Add and Update Items
- List and Export Clients and Contacts
- Create a Client
- Update a Client
- Add Items (and price)
- Update Items (and prices)
- List Currencies
- List Tax Codes
- List Account Codes
Generate your API key by going to the Cog -> Business Settings ->API Key and click on 'Generate'.
You can find details of the API's:
To test the API, get your API key from within the system:
Cog -> Business Settings -> API Key -> Get API Key
Put the key into the API's page at the top and click on 'Explore' and choose a call to test.
Zigaflow uses HTTP Basic authentication in order to determine which client is making calls to the API. You will need an API key for accessing the API. To find the API key, please log in to their account and find the cog on the top right, then go to Your Business => Api Key.
You will need to include your API key as the Base64-encoded user name, leaving the password blank.
When creating and updating objects via the API it is important to use valid identifiers. For example, when linking a tax code to a product, you must provide a valid tax_code_id and product_id. (If you do not already have said IDs, you will need to look them up.)
Example API Call
If we wanted to retrieve all the products for this client with an API key of 8e86340f-80ca-4a91-9ed5-2fed42f8bd69, we would use the following GET call with the Authorization header:
Authorization: Basic OGU4NjM0MGYtODBjYS00YTkxLTllZDUtMmZlZDQyZjhiZDY5
Searching and Filtering
Two query string parameters on GET requests give you paging options:
To specify a number of records to be returned, add a "top" query parameter with the number of records. For example, to return just the top 10 product records, you would use the following GET request:
To skip the first 20 records and return the next 10 after that (useful for paging records) you can use a combination of the TOP and SKIP query parameters as follows: