CARTO User Manual

CARTO for developers

The CARTO Workspace has been designed to make the development of web-based spatial applications as easy as possible. To achieve this, the Developers section provides access to a complete set of app development tools that includes APIs, SDKs, development frameworks, and database connectors to simplify the analysis of massive spatial datasets and the development of powerful Location Intelligence applications.

The developer toolkit includes industry-leading visualization, mapping, and application design components, giving developers unparalleled flexibility to create truly beautiful geospatial user experiences for desktop and mobile.

API Base URL

The API with the base CARTO URL is displayed. You can copy and use it by clicking on the icon on the right.

LDS Token

The LDS (Location Data Services) Token is displayed. This is the customer’s token for accessing the different LDS API services and it is a required parameter in all of LDS functions in BigQuery. You can copy and use it by clicking on the icon on the right.

Managing built applications

The CARTO Workspace includes options for managing your applications. From the Settings section, you can create, edit, or delete applications.

Creating applications

You can create new applications that will be used for development of custom web and backend applications. The first time you access the Developers section, you will see the following page:

To create a new application, click on Create new button. Then you will see the new application setup options. You can create a new application with basic information, or a new application that includes advanced settings.

Creating applications with basic information

Enter the basic information:

• Name
• Description (Optional)
• App URL
• Thumbnail URL (Optional)
• Click Save

Creating applications with advanced settings

Enter the advanced information:

• Application type

You can access the drop-down menu to select your application type by clicking the arrow in the right hand corner. There are 3 options available: Single Page Application, Machine to Machine, and Regular Web Application

• Token Endpoint Authentication Method

You can access the drop-down menu to select your token endpoint authentication method by clicking the arrow in the right hand corner:

Click Expand more info if you need more information about this authentication method and click Collapse to close.

• Application Login URL

Click Expand more info if you need more information about this authentication method and click Collapse to close.

• Allowed Callback URLS (Optional)

Click Expand more info if you need more information about this authentication method and click Collapse to close.

• Allowed Logout URLS (Optional)

Click Expand more info if you need more information about this authentication method and click Collapse to close.

• Allowed Web Origins (Optional):

Click Expand more info if you need more information about this authentication method and click Collapse to close.

• Allowed Origins (CORS) (Optional):

Click Expand more info if you need more information about this authentication method and click Collapse to close.

Click Save for saving your changes.

Editing applications

In the Built applications section of the Workspace, you will see the list of your currently built applications:

If you are the owner of the application, you will have access to the quick actions menu to manage your built applications by clicking on the three point icon in the top right hand corner. There are 2 options available: Edit and Delete. You can also copy the application ID by hovering your mouse over and clicking on it.

If you click the Edit quick action, you will be redirected to a dialog to edit application parameters. This dialog contains the same form that you filled out when creating the application, showing the current values.

After editing the built application parameters, click the Save changes button. A popup will appear informing you that the app has been successfully created. Otherwise, click Cancel if you don’t want the changes to be applied.

Deleting applications

In the Built applications section of the Workspace, you will see the list of your currently built applications:

If you are the owner of the application, you will have access to the quick actions menu to manage your built applications by clicking on the three point icon in the top right hand corner. There are 2 options available: Edit and Delete.

If you click the Delete quick action, a dialog will appear so you can confirm that you want to delete the selected applicationn. Click the Yes, delete button to confirm the changes or click Cancel if you don’t want the changes to be applied.

Copying ID

In the Built applications section of the Workspace, you will see the list of your currently built applications:

If you hover your mouse over the id, a popup ‘Copy ID’ will appear, and you can copy the id by clicking on it. Once you have copied the id, a popup will appear indicating that the url has been copied.

Guide

You can start creating applications from scratch by using our documentation. By clicking on this banner, you will be redirected to CARTO for React documentation to learn how to create a new application from scratch.

Featured documentation

In this section, you have quick access to different developer toolkits to get started with the build of the most innovative spatial analytics apps: Maps API, BigQuery Analytics Toolbox, CARTO for deck.gl and CARTO for React

You can click on View all button to have access to all CARTO documentation. In these pages, you will find all the resources you need to get the most out of your developments.