The Sortly API is a public API that we provide to our Enterprise customers. If you are unsure of your plan type, you can find that information here.
The API allows you to perform a very specific set of functions within your Sortly account. In the hands of your software developers, they can write simple software programs to communicate with objects in your Sortly account and automate tasks between other cloud-based applications.
FAQ
What is an API?
An API (Application Programming Interface) is a set of tools that allows software developers to interact with a cloud-based application. It enables the creation of custom applications and integrations by performing specific functions within the application. Examples of popular APIs include those from Google Maps, YouTube, and Twitter.
Where can I find my API Key?
To locate your API Key:
- Go to the Settings tab in Sortly.
- Click on Public API (beta).
- Click Create Key Pair to generate a unique API Key.
- Name your API Key and set an expiration date if desired, then click Create.
- Your Public Key and Secret Key will be displayed. Make sure to save these keys.
- Click Close this window, I have a key pair.
- Your active API Key will be visible in Settings >> Public API.
To edit or delete the API Key, use the options to the right of the active key.
What actions can be performed using the Sortly API?
The Sortly API allows you to perform various actions, including:
- Item changes
- Units of measure
- Custom fields
- Alerts
For a comprehensive list of actions and detailed instructions, refer to our API Documentation.
Can Sortly build this type of integration for me?
Currently, API integrations are self-service. You will need to collaborate with a developer to create and manage your integrations with Sortly.
What is the rate limit for the Sortly API?
The Sortly API allows for 1,000 requests per 15-minute window. Rate limit details are included in the HTTP headers of the API response.
How can I find out if certain software can be integrated with Sortly?
Check with the software provider to see if they offer an API. If they do, integration with Sortly may be possible. However, we cannot guarantee compatibility with all third-party APIs.
Is it possible to add items, folders, or other elements to the system using the API?
Yes, you can use the Sortly API to bulk import or bulk edit items. For a detailed tutorial and additional information, please refer to our resource guide.