/app
is the business layer of Axeptio, used to collect / import / export consent proofs/vault
is the document store where we put all the configurations (cookies, projects, etc.)/auth
is the authentification gateway that issues access tokens and allow 3rd party logins/webhooks
allows customers to register endpoints that we will call on specific events/assets
is a file upload service that can handle and serve optimized renders of image files (using imgix)/publish
is the orchestration service that packages and deploy the project configurations (relies on AWS S3 and Cloudfront)/billing
is the Stripe Billing gateway servicePOST https://api.axept.io/v1/auth/local/signup
?access_token=${response.body.token}
Authorization: Bearer ${response.body.token}
POST https://api.axept.io/v1/auth/local/signin
POST https://api.axept.io/vault/${resource}
PUT https://api.axept.io/vault/${resource}/${documentId}
DELETE https://api.axept.io/vault/${resource}/${documentId}
POST https://api.axept.io/vault/${resource}/${documentId}/users
Project
document. This project contains:POST/PUT/GET/DELETE https://api.axept.io/v1/vault/projects(/${project._id})
POST/PUT/GET/DELETE https://api.axept.io/v1/vault/cookies(/${cookieConfiguration._id})
Configuration
objectsteps
: an array of step
, corresponding to the consecutive steps in the cookie widget.strings
: an object containing the user-facing messages of the widgetconsentWidgetStrings
: an object containing the user-facing messages for the consent proof collectionsettings
: an object containing apparition and UX settingsprojectId
: the ID of the project (used for joining projects and configuration in the admin panel)Step
objectname
is the unique string identifiertitle
, topTitle
, subTitle
, : plain text stringsmessage
: HTML text content displayed under the titlesimage
URL or asset identifier for the upper right imagelayout
is a string that can take one of the following options:welcome
category
info
: (Not free)iab
: (Not free)soft_consent
: (Not free)vendors
is an array containing vendor objects (not compatible with welcome
layout)strings
is an object overriding the Cookie Configuration strings
proptimeout
number in ms, is the time before the step goes away, only available in soft_consent
and info
layouts.showToggleAllSwitch
boolean that dictates whether there's a big toggle switch to rule all the vendors or notVendor
objectPOST/PUT/GET/DELETE https://api.axept.io/v1/vault/processings(/${consent._id})
projectId
: string
ID of the project (used to join project and Consent box in the admin panel)title
: string
subTitle
: string
picture
: url
icon displayed in the top right placeholdermessage
: text of the widget (can be html)purpose
: Purpose of the data processing (GDRP compliant explanation for the data processing)buttons
: it's an array
that contains the definition of each button displayed at the bottom of the consent box. This definition consists of the following fields : text
, color
(primary or default), value
confirmations
: object
defines the content and behaviour of confirmation screens. Each screen is described by the fields title
, message
and backButtonText
processors
: an array
of data processors objects
. A processor is defined by the properties name
, shortDescription
, role
, and website
.personalDataTypes
: an array of strings
describing every type of personal data involved in the data processing (ex: 'first name', 'last name', 'phone number', etc.)automatedDecisions
: booleanautomatedDecisionsContact
: text person to contact in case of automated decisions related claimautomatedDecisionsDetails
: text GDPR compliant explanation of automated decisionsconsentWithdraw
: text GDPR compliant explanation of the consent withdrawal procedurestorageDuration
: number in month, how long are the data collected will be stored.POST/PUT/GET/DELETE https://api.axept.io/v1/vault/contracts(/${consent._id})
projectId
: string
ID of the project (used to join project and Consent box in the admin panel)file
: string
URL of the file that will be opened in the browser.title
: string
subTitle
: string
name
: string
attribute of the <input>
checkbox that will be appended to the parent formmessage
: text of the widget (can be html)idRequired
: Boolean that will be translated to required="required"
in the <input>
tag.buttons
: it's an array
that contains the definition of each button displayed at the bottom of the consent box. This definition consists of the following fields : text
, color
(primary or default), value
timeout
property in the payload or defaulting to 500ms between polls.https://api.axept.io/v1/publish/jobs/${project._id}
with a POST request (no payload required). You shall receive a similar payload:payload.links.self
to start your polling. Beware, there is no quota policy enforced, we expect our customer to be responsible. Do not DDOS the API by forgetting to delay your polling.