Welcome to Digity API

API Overview

Welcome to the Digity API documentation. Here you can find information about our API endpoints, authentication, and how to integrate with our services. To get an API key, please contact us.

Authentication

All requests to our API require an API key to be passed in the headers. Use the header X-API-KEY to authenticate your requests. Here is an example of how to include it:

GET /v1/check-availability
Host: api.3digity.com
X-API-KEY: your-api-key-here

Available Endpoints

GET /v1/check-availability

Check the availability of the tool Size Wizard.

Example API Response (UTC format): "2024-10-14 15:10:42"

POST /v1/upload-image

Sends an image to the API for analysis.

Parameters to pass:

image: The image file to upload.
request_information: A JSON string containing additional data.

The API responds with a numerical ID of the uploaded image.

GET /v1/get-info

Get the status of a processed image.

Parameters:

id: The ID of the uploaded image.

Example Response:

{
    "success": true,
    "id": 4,
    "state": 0,
    "state_description": "Waiting in the processing queue...",
    "result": null,
    "result_image": null
}

GET /v1/get-state-description

Get a message depending on the current status.

Parameters:

state: The status of the image analysis.

Example API Response:

{
    "success": true,
    "state_description": "Sending the image to our proprietary algorithm..."
}