SDK reference
Options, methods, events and errors of the browser runtime and the Node.js, Python, iOS and Android SDKs, for developers looking something up.
Look up an option, a method, an event or an error of the browser runtime and of the server and mobile SDKs. Every page has the same order: requirements, install, creating the client, then each method with its parameters, return value, errors and an example.
These pages are for developers who already know what they want to call. For step-by-step instructions, use the Developer guide. For the HTTP calls behind the SDKs, use the API reference.
Start with:
- Browser runtime options, to load the runtime on a website
- Node.js client or Python client, to call the API from your server
- iOS SDK or Android SDK, to record consent from an app
Browser
- Browser runtime optionsEvery script-tag attribute, configuration option and markup attribute the browser runtime reads, with its type and default.
- Browser runtime methodsEvery property and method of window.PiedapConsent and of the npm controller, with parameters, return values, errors and examples.
- Browser runtime eventsThe events the browser runtime sends through on(), the piedap:consent DOM event and the data layer push, with when each one fires.
- Cookies and browser storageThe cookies and local storage keys the browser runtime writes, their formats and lifetimes, and the functions that parse them.
Server
- Node.js clientInstall @piedap/consent on your server, create a ConsentClient and look up every client method with its parameters, return value and errors.
- Node.js helpersThe helper functions of @piedap/consent/server for webhook signatures, identity proofs, fingerprints, capture hashes, skipped imports, cookies and receipts.
- Python clientInstall the piedap-consent package, create a ConsentClient and look up every client method, model and exception.
- Python helpersThe helper functions of the piedap_consent package for webhook signatures, identity proofs, fingerprints, capture hashes, skipped imports and cookies.
Mobile
- iOS SDKAdd the PiedapConsent Swift package to an iOS or macOS app, create the client and look up every method, type and error.
- Android SDKBuild the consent jar for an Android app, create the client and look up every method, type and exception.