Keyspaces
Keyspaces allow to identify the profiles using different profile keys. Specific operations can be performed on a profile identified through a particular keyspace.
Unique identifiers
Unique identifier is used to locate the profile and consists of a keyspace discriminator and a profile key within that keyspace. Any given profile can have multiple unique identifiers (profile keys) however each of them must belong to a different keyspace.
Profile access
Profile access via One API is allowed through the specified keyspaces only.
Keyspace permissions
Specific profile attribute and tag types can be read or written when a profile is identified through a profile key in a specific keyspace. To find out which, use the include_keyspace_permissions request parameter with Get attributes and Get all tags.
Subscription management
Subscriptions (consent) can only be managed via keyspaces with manage_subscriptions flag set to true.
Keyspaces supported by APSIS One API
Full support:
- Email Keyspace (
com.apsis1.keyspaces.email) uses email address as key and can be used to perform all profile operations. - SMS Keyspace (
com.apsis1.keyspaces.mobile) uses mobile phone number as key and can be used to perform all profile operations. - CRM Keyspace (
com.apsis1.keyspaces.crm-id) uses CRM-ID as key and can be used to perform all profile operations. Profile keys in this keyspace are initialized in a third party system.
Partial support:
- Export Keyspace (
com.apsis1.keyspaces.export) uses export keys to identify the profiles. These profile keys appear in the export files provided by this API and in the browser address bar when looking at a profile. This keyspace is read only and allows for reading profile attributes, tags, events and consents. It also supports locking, deleting and merging profiles.