Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Zip

This documentation for the Zip integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Zip, visit our connection instructions.

Version​

This integration utilizes the Zip REST API.

Base URL​

The base URL used for all Zip API endpoints:
https:​//api.ziphq.com

Endpoints Utilized​

DataGrail uses the following endpoints to authorize and test the connection:

MethodEndpointPurposeDocs
GET/usersValidate credentials

Authentication & Authorization​

The DataGrail Zip integration connects using API Key authentication which requires an API Key.

Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to Zip API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Limits​

Limits in Zip are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

  • DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
  • DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Capabilities​

Access​

DataGrail's Zip integration provides Synchronous Access capabilities for the following supported identifier categories: Email and User ID.

Data Interactions​

For Access requests, DataGrail will take the following actions:

  1. Search users using congigured identifiers.
  2. Search requests using congigured identifiers.

Endpoints Utilized​

MethodEndpointPurposeDocs
GET/requestsSearch requests
GET/usersSearch user

System Detection​

DataGrail provides continuous system detection, delivering a real-time inventory of your data assets.

Data Interactions​

DataGrail's System Detection process runs once daily and performs the following actions:

  1. Retrieve vendors.

Endpoints Utilized​

MethodEndpointPurposeDocs
GET/vendorsSearch vendors

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.