Asset Panda API Documentation

Welcome to the Asset Panda API documentation. Our API provides powerful tools to integrate and automate your asset management using Asset Panda's platform. This guide will help you understand how to get started, authenticate your requests, and implement common use cases to maximize your asset management efficiency.

Let's Get Started

To begin using the Asset Panda API, you will need to have an active Asset Panda account. Once your account is set up, you can access the API by generating an API key and secret through the Asset Panda UI. This documentation will guide you through the steps needed to make API calls successfully, including authentication, handling responses, and understanding the provided endpoints.

Setting Up Your Asset Panda Pioneer Account

To begin, you'll need an Asset Panda Pioneer account. If you're new to Asset Panda, sign up on our platform to access the full suite of asset management tools. Existing users can proceed by logging into their account.

Navigating to API Configuration

Once logged in, navigate to the settings area of your dashboard. Here, you'll find the API Configuration section, which is your starting point for API integration.
Generating an API Key

Generate an API key:

1. In the API Configuration section, click on Create New API Key.
2. Fill out the form, which includes naming your key and assigning the appropriate permissions. You have the option to enable permissions for read, write, and delete operations according to your requirements.
3. Save your API key and secret in a secure place; they are essential for authenticating your API requests.
   Permissions
   When creating an API key, you will be prompted to set permissions that align with your use case. For enhanced security, it's best to grant only the necessary permissions needed for your tasks.
   • Read: Permission to retrieve and view collection records.
   • Write: Permission to create new records and update existing ones.
   • Delete: Permission to remove records from a collection.

Make sure to record your API key and secret in a secure location, as they will not be displayed again. Don't forget to save your settings once you're done!

Authentication

Making Authenticated Requests

To authenticate an API request, include your API key and secret in the request headers:

• Access-Key-Id: Your generated API key
• Access-Key-Secret: Your generated API secret

Use Cases and Workflow

The Asset Panda API supports a variety of operations tailored to facilitate robust asset management workflows. Below are some typical use cases you might implement:

• Retrieving Account Information
  Fetch details about your account to verify API connectivity and access specifics of your asset management setup.
  Endpoint: GET /account/{accountId}

• Managing Collections
  You can manage collections, which are groups of assets organized by similar properties.
  Endpoints:

  • List all collections: GET /collections?accountId={accountId}&moduleId={moduleId}
  • Retrieve a specific collection: GET /collection/{collectionId}?accountId={accountId}&moduleId={moduleId}

• Manipulating Collection Records
  Handle individual records within a collection by creating, updating, or deleting them based on your operational requirements.
  Endpoints:

  • Create a new record: POST /collection-records
  • Update an existing record: PUT /collection-records/{recordId}
  • Delete a record: DELETE /collection-records/{recordIds}