Didomi

Didomi widgets/notices/remote-configs API

The widgets/notices/remote-configs API from Didomi — 1 operation(s) for widgets/notices/remote-configs.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.didomi.io/api-and-platform/introduction
📖
Authentication
https://developers.didomi.io/api-and-platform/introduction/authentication
📖
RateLimits
https://developers.didomi.io/api-and-platform/introduction/rate-limiting

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/openapi/didomi-widgets-notices-remote-configs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-consent-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-consent-notice-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-privacy-request-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-structure/didomi-consent-event-structure.json

Other Resources

🔗
ErrorCodes
https://developers.didomi.io/api-and-platform/introduction/errors
🔗
Pagination
https://developers.didomi.io/api-and-platform/introduction/pagination
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-consent-event-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-consent-notice-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-privacy-request-example.json

OpenAPI Specification

didomi-widgets-notices-remote-configs-api-openapi.yml Raw ↑ 
openapi: 3.0.2
info:
  title: Didomi consents/events widgets/notices/remote-configs API
  description: 'A REST API to communicate with the Didomi platform (<a href="https://api.didomi.io/v1/">https://api.didomi.io/v1/</a>)


    This is the complete specification of the API. A complete guide to authenticating and using the API is available on our <a href="https://developers.didomi.io/" target="_blank">Developers Portal</a>.


    All HTTP calls to the API require a valid JWT token. The token must be provided in an **Authorization** header with the value "Bearer <token>".

    Click on the Authorize button in the header of this page to provide a token before testing requests from this documentation.


    '
  version: '1.0'
servers:
- url: https://api.didomi.io/v1
  description: Didomi Platform API
security:
- bearer: []
tags:
- name: widgets/notices/remote-configs
paths:
  /widgets/notices/remote-configs:
    post:
      summary: Deploy a SDK config
      description: Directly deploy a SDK config to the production environment for the property
      security:
      - bearer: []
      parameters: []
      responses:
        '200':
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdk-configs'
        '401':
          description: not authenticated
        '403':
          description: forbidden
        '500':
          description: general error
      tags:
      - widgets/notices/remote-configs
      consumes:
      - application/json
      produces:
      - application/json
components:
  schemas:
    sdk-configs:
      type: object
      title: Didomi SDK configuration
      description: Consent notice configuration structured for a Didomi SDK
      properties:
        config:
          type: object
          description: Didomi SDK configuration (see https://developers.didomi.io/cmp/introduction)
      required:
      - config
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http