Endpoints Overview

DePINscan currently provides the following API endpoints:

post

This endpoint is used for uploading device identifiers and their associated longitude and latitude.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

versionstringRequired

version

Body

application/json

uidstringRequired

user id

Responses

200

Upload successfully.

application/json

400

Bad Request

application/json

post

/api/upload-device-metrics

HTTPcURLJavaScriptPython

POST /api/upload-device-metrics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
version: text
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "uid": "text",
  "events": [
    {
      "publisher": "text",
      "timestamp": "text",
      "custom": {
        "longitude": 1,
        "latitude": 1
      }
    }
  ]
}

{
  "message": "text"
}

get

This endpoint is used for getting project publishers by project id.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

uidstringRequired

Project Id

Responses

200

Get project publishers successfully.

application/json

Responsestring[]

publishers

400

Bad Request

application/json

get

/api/project/{uid}/publishers

HTTPcURLJavaScriptPython

GET /api/project/{uid}/publishers HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

delete

Delete all devices by project id.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

uidstringRequired

uid

Responses

200

Delete all devices successfully.

application/json

400

Bad Request

application/json

delete

/api/delete-all-devices

HTTPcURLJavaScriptPython

DELETE /api/delete-all-devices HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "uid": "text"
}

{
  "message": "text"
}

Please use the DELETE method with caution, as it currently deletes ALL devices from your project. This action is not reversible!