ZapDigits
    ZapDigits
    • Introduction
    • Authentication
    • Datasets
    • API Limits
    • Datasets
      • Create a dataset
        POST
      • Retrieve a dataset
        GET
      • Update a dataset
        PATCH
      • Delete a dataset
        DELETE
    • Schemas
      • Datasets

    Introduction

    Current version#

    The current REST API integration version is v1 which is our first beta release of the API.

    Requirements#

    To use the latest version of the REST API you must have:
    A ZapDigits account
    You may access the API over HTTPS
    Free trial does not include the API access
    This Document will act as a Onboarding Document for the Developers and will the developers in getting started and help you create dynamic and cusom dashboards.

    Request/Response Format#

    The default response format is JSON. Requests with a message-body use plain JSON to set or update resource attributes. Successful requests will return a 200 OK HTTP status.
    Some general information about responses:
    Dates are returned in ISO8601 format: YYYY-MM-DDTHH:MM:SS
    Resource IDs are returned as integers.
    Any decimal monetary amount, such as prices or totals, will be returned as strings with two decimal places.
    Other amounts, such as item counts, are returned as integers.
    Blank fields are generally included as null or emtpy string instead of being omitted.

    Errors#

    Occasionally you might encounter errors when accessing the REST API. There are four possible types:
    Error Code Error Type
    400 Bad Request Invalid request, e.g. using an unsupported HTTP method
    401 Unauthorized Authentication or permission error, e.g. incorrect API keys
    404 Not Found Requests to resources that don't exist or are missing
    500 Internal Server Error Server error
    Error example:

    Support#

    For any development support please contact us via chat or shoot an email to hello@zapdigits.com
    Modified at 2025-09-13 12:51:48
    Next
    Authentication
    Built with