Welcome to the TerraGo API Documentation

Welcome to the TerraGo API documentation. This guide provides all the information you need to interact with our services programmatically.

Getting Started

To begin, you will need an API token. Authentication is via Bearer token. Include it in your request headers as shown:

Authorization: Bearer {{token}}

Base URLs

Depending on the environment, use the appropriate base URL:

  • Staging : https://terragostg.terrasofthq.com/api
  • Live : https://terragolive.terrasofthq.com/api

Request Format

All requests and responses use JSON format.

Error Handling

The API uses standard HTTP status codes. Common codes include:

  • 200 - OK
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 500 - Internal Server Error

Tips

  • Use tools like Postman or cURL to test endpoints.
  • Include authentication headers for protected endpoints.
  • All endpoints follow REST conventions.
  • Use the staging URL for testing before deploying to live.