Land of Assets Documentation
Welcome to the Land of Assets documentation! This guide will help you get started with integrating Land of Assets into your projects.
Land of Assets is designed for automation and integration. Whether you are building a CLI tool, a web application, or an automated pipeline, we have the tools you need.
REST API
Our REST API provides programmatic access to all Land of Assets functionality. The API is fully documented with interactive examples:
The API documentation includes:
- Complete endpoint reference
- Request/response schemas
- Authentication examples
- Code samples in multiple languages
JavaScript/TypeScript SDK
For JavaScript and TypeScript projects, we provide a fully typed SDK that wraps the REST API:
The SDK provides:
- Full TypeScript support with complete type definitions
- Convenient wrapper functions for all API endpoints
- Built-in request/response validation using Zod schemas
- Automatic error handling
Installation
npm install @landofassets/sdk # or pnpm add @landofassets/sdk # or yarn add @landofassets/sdk
Authentication & Tokens
Land of Assets uses token-based authentication. All tokens are built upon service accounts, which you can create and manage in your project settings.
Token Types
We support two types of tokens, each designed for different use cases:
Secret Tokens
Secret tokens are intended for server-side use and can manipulate any data in your account. These should be kept secret and never exposed in client-side code or public repositories.
- Use for: Backend services, server-side scripts, CI/CD pipelines
- Security: Keep these tokens secure and never commit them to version control
Frontend Tokens
Frontend tokens are designed to be used in web pages and client-side applications. These tokens can access assets but cannot modify data, making them safe to expose in public-facing code.
- Use for: Web applications, browser-based tools, public demos
- Security: Safe to include in client-side JavaScript (though still recommended to restrict access via CORS)
Creating Tokens
You can create service accounts and both token types in your project settings:
- Navigate to your project settings
- Go to the "Service Accounts" section
- Create a new service account
- Generate secret tokens or frontend tokens as needed
CLI Tool
For command-line workflows and automation, we provide a CLI tool:
The CLI tool supports:
- Managing assets, organizations, projects, and versions
- Uploading and downloading files
- Authentication and token management
- Batch operations and automation scripts
Installation
npm install -g @landofassets/cli # or pnpm add -g @landofassets/cli # or yarn global add @landofassets/cli
Authentication
The CLI supports two authentication methods:
-
Personal Account Login: Authenticate using your personal Land of Assets account credentials
loa auth login -
Secret Token: Use a secret token for automated workflows
loa auth token <your-secret-token>
Getting Started
-
Choose your integration method:
- Use the Web Dashboard for visual management
- Use the REST API for direct HTTP access
- Use the SDK for JavaScript/TypeScript projects
- Use the CLI for command-line workflows
-
Install the Tools:
# Install the SDK npm install @landofassets/sdk # Install the CLI npm install -g @landofassets/cli -
Set up authentication:
- CLI: Run
loa auth loginto authenticate via browser - SDK/API: Create a service account in your project settings and generate a token
- CLI: Run
-
Start building:
- Explore the API documentation for available endpoints
- Check out the SDK examples for common use cases
- Use the CLI for quick operations and testing
