Skip to Content
DocumentationLayer One APIREST APIOverview

REST API

The Layer One REST API provides a comprehensive HTTP-based interface for interacting with our platform services. Built following RESTful principles, it offers intuitive endpoints for all major operations.

Key Features

  • RESTful Design - Clean, predictable URLs and HTTP methods
  • JSON Format - All requests and responses use JSON
  • HTTP Status Codes - Standard status codes for error handling
  • Rate Limiting - Built-in rate limiting for optimal performance
  • Versioning - API versioning to ensure backward compatibility

API Fundamentals

Base URL

All API requests should be made to:

https://api.integrated-projects.com/v1

Content Type

All requests should include the appropriate content type header:

Content-Type: application/json

Request Structure

A typical API request includes:

  • HTTP Method (GET, POST, PUT, DELETE, PATCH)
  • Endpoint URL
  • Headers (including authentication)
  • Request Body (for POST, PUT, PATCH requests)

Example Request

curl -X POST \
  https://api.integrated-projects.com/v1/authentication/token \
  -H "Authorization: Basic <BASE64_ENCODED_CLIENT_ID_AND_SECRET>" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "grant_type": "client_credentials"
  }'

Response Format

All API responses follow a consistent JSON structure:

{
  "data": {},
  "status": "success",
  "message": "Operation completed successfully"
}

Rate Limiting

The API implements rate limiting to ensure fair usage:

  • Standard: 1000 requests per hour
  • Premium: 5000 requests per hour

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Supported Products

BIMIT Plan (areaplan)

Automated 2D floor plan generation service that transforms 3D point cloud data into accurate, scaled floor plans. This service:

  • Processes point clouds from laser scanners and other 3D capture devices
  • Generates vector-based floor plans with precise measurements and room layouts
  • Identifies building elements such as walls, doors, windows, and openings

See BIMIT Plan documentation for complete technical specifications and implementation details.

Supported File Formats

  • E57 - Industry standard 3D point clouds
  • XYZ - ASCII point cloud format

Next Steps

Now that you understand the basics, learn how to authenticate your requests to start making API calls.

Last updated on
OverviewAuthentication