Aureus 3D API

CyberExtruder’s Aureus 3D API program was put together for developers who want to build applications that use content from, and interact with, CyberExtruder’s 2D to 3D reconstruction technology. The Aureus 3D API is what is known as a RESTful web service for the expressed purpose of enabling authorized individuals and companies the ability to create their own applications using CyberExtuder’s Aureus 3D technology, as well as integrating Aureus 3D technology into their internal operations.

Before we get too far into this, you may be wondering though, do I need an API or an SDK? What's the difference?

API vs SDK
An Application Programming Interface (API) and a Software Development Kit (SDK) play important roles in the software development process. As the name suggests, API acts as an interface among different applications or platforms and helps different software programs to interact with each other. An API generally consists of specifications that can be used to interface between different software programs. On the other hand, SDK, also known as devkit, consists of a set of development tools and prewritten codes that can be used by the developers to develop applications. SDKs generally help to reduce the amount of effort and time needed by the developers to write their own unique code to develop software applications.

An API is an interface. For example, the plug on a lamp and the outlet on your wall are the interfaces between the light bulb and the electricity it needs to operate.  Any lamp can use the outlet (interface) as long as it has the correct plug. In this example, the API is the specification for the plug written down so anyone can make a plug, and therefore light the lamp. Without our plug API, you might make the prongs to large or small. It might work, but it might not. By making a plug according to the plug’s API you ensure it’ll work as intended.

An SDK is implementation tooling. It's a collection (kit) of software that allows you to build something custom.  Using our plug example, the lamp’s SDK would include the plug’s API (remember this is like having an instruction sheet) a wire stripper, a sample plug some electrical tape and a screwdriver. The SDK would have all the tools needed to make the lamp work reliably. With this kit and the understand that having used it brings, you would have the ability to make other plugs with other features and functions to meet the needs of other lamp-like jobs.

Technically, if an API is well-documented, you don't need an SDK to build your own software to use the API. But having an SDK generally makes the process much easier.

Some APIs have security provisions to require license keys, authentication, etc. which may prohibit complete use of the API in particular instances (think child proof plugs), but that's only because particular authentication/authorization steps fail. Any software that presents the right credentials (if required) can use the API.

The simplest explanation we’ve ever heard is: you build something with an SDK and you use or consume something with an API.

Using the Aureus 3D API
Aureus 3D API users can communicate with the API endpoint through a "wrapper PHP object". The "wrapper PHP object" provides a very simple interface and internal data management, suitable for all communications with the Aureus 3D API. Depending upon your web site environment, one of the two sets of sample code provided in the documentation should answer your implementation questions.

Regardless of the web site environment, (or even of the end user is not a web site at all, but a desktop application) the "wrapper PHP object" provides an interface to the Aureus 3D API. The Aureus 3D API is a RESTful Web API, which is a very popular Web API architecture, easily handled in all  popular programming languages.

If your environment is not PHP based, the complementary logic for communications should be very much like the first "wrapper PHP object" implementation found in the documentation. That first wrapper implementation uses the PHP version of the CURL library for API communications, and the CURL library is available almost everywhere, including command line versions for those languages that don't have a libcurl port.

To get access to our API and see the documentation we're talking about, all you have to do is register with CyberExtruder and agree to the terms of the API license. We'll then provision you with your API key and access credentials.  No additional license beyond the API license agreement is required.

If you are going to use the API for any commercial purpose or derive any compensation in any way (like ad revenue from a website which uses or promotes the API) that is not specifically authorized in the API license agreement, you must agree to the appropriate commercial terms.

If you want to use the API (and we’d love for you to use it!) in your business, sell something you created which uses our API, sell services or training in connection with that business, distribute an application you've created using the API, or use the API in any way to generate revenue, directly or indirectly, in addition to executing API license agreement, you are required complete Schedule 1 of the API license agreement and indicate the correct business model for your application.

CyberExtruder’s API license agreement may be executed by an individual or a corporate entity. If an unincorporated team wishes to license the API, we recommend setting up a simple corporation or partnership for the team before contacting us for a license. If that is not feasible, please designate a single individual to contact us who will be responsible for executing the license and fulfilling the terms.

If you have any questions about licensing CyberExtruder’s API or require custom license terms please call our office at +1.973.623.7900 or email Jack Ives at JDIves@CyberExtruder.com for more information.