Quickstart

This guide will help you get up and running quickly. Follow these steps to start integrating CAPTUR3D into your application.

1. Create a CAPTUR3D Account

First, sign up for a CAPTUR3D account at https://captur3d.io. If you already have an account, you can skip this step.

2. Generate an API Token

Once logged in, navigate to the Settings page and generate an API token. This token is required for authenticating your requests. Be sure to store it securely, as it provides access to your CAPTUR3D data.

3. Make Your First API Request

Use your API token to authenticate requests. Below is a simple example using curl to our /api/v2/heartbeat endpoint:

curl -H "Authorization: Bearer YOUR_API_TOKEN" https://captur3d.io/api/v2/heartbeat

If everything is set up correctly, you should receive a response with HTTP status of 200.

4. Explore More API Endpoints

Now that you're set up, check out the full API documentation to explore available endpoints and integrate CAPTUR3D into your workflow.

5. Receive Webhooks for Real-Time Updates (optional)

CAPTUR3D provides webhooks to notify you of important events, such as when a floor plan is processed or an order is updated. You can configure your webhook endpoints in the Developers page.

6. Profit! 🚀

You're now ready to use the CAPTUR3D API to streamline your operations. Whether you're managing floor plans, syncing data, or automating workflows, the API has you covered!