Qodex.ai

Augurisk-api/v1

Number of APIs: 17

API Reference

The Augurisk API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Instructions

Make sure to replace {{Apikey} with your private or public API Keys, and the {{variables}} under brackets with the appropriate parameters.

Currently, the public API key works with the Risk data/getRisksMetered and Risk data/getLayers endpoints, allowing you to use these directly on your client-side apps. You can define a whitelisted domain for the public API key, and they have a lower rate limit value compared to the private key.

If you click on Run in Qodex, make sure to select the Production environment, and to replace the ApiKey with your Api Key, that you can find under API Access under the menu on app.augurisk.com for Enterprise subscription users.

Errors

Augurisk uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Augurisk's servers.

For any further question get in touch with our team on the Augurisk contact page.

  1. Risk data - getRisksMetered GET https://{{base_url}}/v1/getRisksMetered/?latitude={{latitude}}&longitude={{longitude}}

  2. Risk data - getLayers GET https://{{base_url}}/v1/layers-radius/{layer}/{zoom}/?lon={longitude}&lat={latitude}&radius={radius}&srid=4326&riskData={showData}

  3. Projects - getProjectsById GET https://{{base_url}}/v1/getProjectsById/{{Project_Id}}

  4. Projects - getProjects GET https://{{base_url}}/v1/getProjectsByUserEmail

  5. Risk data - getAllRisks GET https://{{base_url}}/v1/getAllRisks/{{Project_Id}}

  6. Projects - postProjects POST https://{{base_url}}/v1/postProjects

  7. Users - getUsers GET https://{{base_url}}/v1/getUsersByEmail

  8. Misc - search GET https://{{base_url}}/v1/search/

  9. Alerts - getAlertsById GET https://{{base_url}}/v1/alert/getAlertsById/{{Alert_Id}}

  10. Alerts - getAlerts GET https://{{base_url}}/v1/getAlertsByUserEmail