dipp REST API
    dipp REST API
    • Welcome to dipp REST API
    • OAuth Integration
      • Dipp OAuth Integration Guide
      • OpenID Connect Discovery
        GET
      • Authorization Endpoint
        GET
      • Token Endpoint
        POST
      • UserInfo Endpoint
        GET
      • UserInfo Endpoint (POST)
        POST
      • Token Revocation Endpoint
        POST
      • JSON Web Key Set
        GET
    • Get brands
      GET
    • Get layouts
      GET
    • Download CSV template
      GET
    • Get current quotation
      GET
    • Create campaign
      POST
    • Get campaigns
      GET
    • Download product bundle image by data
      POST
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag
      • Schemas
        • Generic Error
        • DiscoveryDocument
        • Validation Error
        • TokenResponse
        • UserInfo
        • Address
        • JWKS
        • JWK
        • OAuthError
        • ConsentResponse

    Welcome to dipp REST API

    Introduction#

    Our REST APIs comprise of HTTP methods that you can use to build integrations that don't rely on interactions in the dipp interface.
    The dipp REST API is fully described in an OpenAPI 3.1 specification.

    What can I do with the dipp REST API?#

    Our REST APIs provides a way to automate campaign creation using a CSV file without touching the visual editor.
    Recommend starting with a layout which is simple and predictatble like product thumbnails.

    Quickstart#

    Make your first REST API call in less than 3 minutes.

    Get API Key from the dipp platform#

    To get started, please visit https://massimo.withdipp.com/ and navigate to User setting -> User API Key -> Generate API Key to generate your API key.
    Please save your API key and add a parameter in each http request header for authorization: X-API-KEY: {{your_api_key}}
    Do not share your API key with others, or expose it in the browser or other client-side code. In order to protect the security of your account, We may also automatically disable any API key that has leaked publicly.

    Try it out#

    You can test REST APIs directly on this website! Go to the next page and click Try it out.
    You need to get your API key first and paste it to Auth -> API Key -> Value before you start.
    Modified at 2024-06-24 03:38:26
    Next
    Dipp OAuth Integration Guide
    Built with