How to create an AutoApi

Step-by-Step Guide

Step 1: Go to the screen to create the AutoAPI.

Navigate to the AutoAPI section in your Orchestrator toolbar.

Step 2: Create the AutoAPI.

You will be directed to a new window displaying all the AutoAPI you have created. To create a new AutoAPI, click the + button.

Step 3: Fill the Create AutoAPI Endpoint Form

Add the necessary information for your AutoAPI and select a method (Endpoint).

Step 4: Edit the AutoAPI settings

Select EDIT on your AutoAPI to access the settings.

Step 5: GET AutoAPI

Enter settings in the case of making a GET AutoAPI.

• Select one or more tables or a cube (KUBE) to provide and update information.
• Select your columns to share in your AutoAPI.

Save the changes to use your AutoAPI!

Step 6: Buckets in AutoAPI

Buckets are an integral part of the AutoAPI system, used to store and manage files, resources, or data payloads. You can:

• Integrate buckets for file storage directly into your AutoAPI workflows.
• Use AutoAPI to retrieve data from or send data to buckets via API calls.
• Manage bucket resources using GET, PUT, POST, and DELETE methods in the AutoAPI interface.

Note:

To securely access and manage buckets, ensure a valid authentication token is included in your request headers. Tokens can be created and managed using AutoAPI.

Key Example: Linking Object Store to Buckets

When working with buckets, it's essential to link the object store to the bucket to ensure smooth operations. For instance, if you select the PUT method to add files but face issues, double-check your configurations to ensure the bucket is correctly associated with the object store.

• Step-by-step actions:
  1. Confirm that the object store is set up.
  2. Navigate to the bucket configuration.
  3. Link the object store with the correct bucket.

By addressing this, you avoid errors in file storage and retrieval workflows.

Refer to the Arpia Bucket API Documentation for more detailed examples and troubleshooting steps.