How-to: Opening FarEarth API documentation

All API interfaces are documented within FarEarth. You can use this API page to test the calls themselves.

Follow these steps to navigate to the API documentation on the FarEarth platform.

1. Log in to FarEarth using your user credentials

2. Navigate to the API page under the DEVELOPER heading

3. Click on API

   

Test API calls

To test API calls, follow these steps.

1. Navigate to the API documentation in FarEarth

2. Click on AUTHORIZE

   

3. Enter the USER API key (see steps to obtain a unique user API key at the top of this page)

4. Close the window

5. Navigate to the API call to test

6. Click TRY IT OUT

7. Enter the required parameters

8. Click EXECUTE

The response will show a curl command equivalent to executing the API query and the valid URL. The response from the server with all headers is shown.