Skip to content
AI-ready version:

Dots.eco API Documentation

Introduction

The Dots.eco API is a RESTful interface designed to enable external parties to interact with Dots.eco without requiring the use of the website. It provides several endpoints that, when properly authenticated, accept requests and return responses in JSON format.

Purpose

The Dots.eco API is intended for Companies to submit impact-related data and receive unique impact certificates in return. This includes sending input related to the following:

  1. Desired Impact Type (e.g., Plant Trees).
  2. Impact Quantity (e.g., the number of trees to plant).
  3. Unique Identifiers:
  4. End-User Identifier
  5. Company Identifier
  6. Application (APP) Identifier
  7. User Email (optional).

API Response

As a result of successful requests, companies will receive a unique Impact Certificate associated with the submitted data for the specified user.

Key Features

  • JSON-Based Communication: Both input and output are formatted in JSON for easy integration.
  • Flexible Configuration: Supports optional user email submission.
  • Impact Certificates: Automatically generates and returns unique certificates based on the provided impact data.
  • Secure Access: All requests require proper authentication using an auth-token to ensure secure communication.

Authentication

To interact with the API endpoints, requests must include valid authentication headers. Refer to the Headers and Authorization section for more details.