Ada
Authentication & Authorization
Credentials
-
Ada APIs use API keys for authorization.
-
You can generate self-serve tokens through the Ada dashboard (see the DataGrail Help Docs).
-
These tokens do not expire and are invalidated if you generate a new one.
-
Publicly exposing your API credentials can allow unauthorized access to the Ada API endpoints, and your Ada data by a third party. DataGrail stores your API credentials encrypted and protected.
Base URL
Base URL consists of the Subdomain and API URL:
https://{SUBDOMAIN}.ada.support
Example of BASE URL:
https://your_subdomain.ada.support
Subdomain can be identified from the account's URL (see the DataGrail Help Docs).
Endpoints Utilized
DataGrail uses the following endpoint to validate that credentials are good based on a successful response:
Get all conversations:
GET {BASE_URL}/data_api/v1.2/conversations/conversations
Delete all data associated with a chatter's by test email address:
POST {BASE_URL}/api/v1/data-subject-request
Version
DataGrail integration currently supports Ada Data Export API version 1.2 (v1.2) and Ada Data Compliance API version 1 (v1).
Limits
DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Access
For an access request, DataGrail will take the following actions:
-
Select conversations related to the requested person using Data Subject email or Service ID for the filtering. Service ID is used as the “chatter_id” in Ada system.
-
For all objects found, DataGrail will return all available fields. You can edit which objects and fields you want to provide to the Data Subject via our Portal Requests.
DataGrail also supports the Direct Contact Access workflow for Ada.
Endpoints Utilized
GET {BASE_URL}/data_api/v1.2/conversations
Deletion
For a deletion request, DataGrail will take the following actions:
- Delete all data associated with a chatter's by email and Service ID using Subject Identifiers.
DataGrail also supports the Direct Contact Deletion workflow for Ada.
Endpoints Utilized
POST {BASE_URL}/api/v1/data-subject-request
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.