DePINScan Documentation
  • Overview
  • Project Integration
  • Map Integration
    • Quickstart
    • Using the API
    • Endpoints Overview
    • Example Call
  • Map Embedding
  • Reporting Issues
Powered by GitBook
On this page
  1. Map Integration

Endpoints Overview

PreviousUsing the APINextExample Call

Last updated 10 months ago

DePINscan currently provides the following API endpoints:

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

delete

Delete all devices by project id.

Authorizations
Body
uidstringRequired

uid

Responses
delete
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"
}
  • POST/api/upload-device-metrics
  • GET/api/project/{uid}/publishers
  • DELETE/api/delete-all-devices
get

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

Authorizations
Path parameters
uidstringRequired

Project Id

Responses
Responsestring[]

publishers

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

[
  "text"
]
post

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

Authorizations
Header parameters
versionstringRequired

version

Body
uidstringRequired

user id

Responses
post
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"
}