Orange Logic takes an API-first approach to development. Therefore, you can call an API to perform most actions that users can take in the user interface.
Orange Logic uses REST APIs that support CRUD (create, read, update, and delete) actions with standard authentication, methods, and response codes. Calls return responses in either JSON or XML format. Many Orange Logic endpoints can be run as simple GET calls with URL-encoded query parameters, making it quick and easy for you to try them out in a browser.
Types of Orange Logic APIs
Some Orange Logic API endpoint paths include /webapi/, while others include just /api/. For example:
POST /webapi/mediafile/import/upload/uploadmedia_4az_v1
POST /api/UploadMedia/v3.0/UploadNewMedia
The /api/ endpoints are legacy calls that are still supported and include a version number in the path.
The /webapi/ endpoints are newer and end with a unique identifier and version number (4az_v1 in the example above). These identifiers ensure that your APIs continue to work as expected, even when Orange Logic needs to update the name of an existing API.
When you have the option to use either an /api/ or a /webapi/ endpoint, use the /webapi/ endpoint. While we still support and document older endpoints, the newest ones typically have the most robust functionality.
In addition to /webapi/ endpoints, Orange Logic also offers /datatable/ APIs that let you work directly with database objects, such as images, video, and audio assets, as well as folders, Groups, users, Tags, and more.
Orange Logic API Versioning
Many Orange Logic APIs have multiple versions. For example, there are three versions of the Upload New Media API:
- /api/UploadMedia/v1.0/UploadNewMedia
- /api/UploadMedia/v2.0/UploadNewMedia
- /api/UploadMedia/v3.0/UploadNewMedia
When you’re setting up a new integration or automation, always use the most recent (highest version number) API. Newer APIs usually have more robust functionality, better performance, or additional parameter options like more flexibility in terms of which identifiers they can accept.
Note
New APIs and new versions of existing APIs are released with specific Orange Logic versions and are not backwards compatible. For example, an API released with Orange Logic Kobe will not work if you’re still using Orange Logic Juneau.
Go to the Release notes article for more information on Orange Logic versions and to review release notes.
API-related tools
Orange Logic offers several tools that can help you create the automations and integrations for which you use APIs. These tools include:
- Generic Asset Browser: Orange Logic's Generic Asset Browser allows users to browse the DAM from external web applications. For example, you could integrate the Generic Asset Browser with a content management system (CMS) so users could find files in the DAM and use them in the CMS without switching platforms.
- Get Link transformations: When you generate links to assets, you can transform the original asset by changing size, format, and more in a custom URL.
- iAPI: iAPI is a Windows desktop application that you can use to perform DataTable API calls in bulk. iAPI allows you to upload CSV files to bulk create, import, update, and delete Orange Logic database records.
- IIIF URLs: Orange Logic supports the International Image Interoperability Framework (IIIF) standards by allowing unregistered users to display assets from your DAM. To learn more about IIIF support in Orange Logic, go here.
- Webhooks: Push changes to external sites when assets are created, edited, and deleted.