The PlanX API allows access to your organizations data for use in external systems. This enables reporting, internal dashboards, analytics, and other activities. The API provides a GeoJSON file of the requested data with project-level details and geometry. GeoJSON format is compatible with all major GIS and reporting software.
Using the API
The following is an example of an API call with the different parameters bolded:
https://ae-api.workflowmanager.app/projects/geojson?format=json&key=yourkey&type=Point&org=yourorg
App Parameter
The "ae" value should be replaced with your respective app. App values are as follows:
- "ae" for the A&E app
- "mpo" for the MPO app
- "dot" for the DOT app
- "city" for the City app
Key Parameter
The "yourkey" value in the link above represents your organizations unique passkey. This can be changed any time in the Org Settings Admin page.
Geometry Parameter
The "Point" parameter identifies the type of geometries you will receive. This allows you to pull point, line, or polygon geometry separately. If this parameter is omitted from the API call all geometries will be provided.
- "Point" for all point geometries
- "Polygon" for all polygon geometries
- "LineString" for all line geometries
- "nogeo" for all projects that have no geometry
The following is an example of the API call without this parameter.
https://ae-api.workflowmanager.app/projects/geojson?format=json&key=yourkey&org=yourorg
Org Parameter
The "yourorg" value is the unique ID for your organization. This ID cannot be changed, do not share this unique ID with others unless you want them to have access to your data. If you inadvertently share it the key can be changed to prevent unwanted access.