Import from HTTP/API¶
Use HTTP/API when a web service needs authentication, extra headers, query parameters, or a POST request.
HTTP/API is not a general-purpose API tester. It downloads a spatial dataset and hands it to GeoJibe's usual inspect and import path.
URL or HTTP/API?¶
| Use | When |
|---|---|
| URL | A public file link. Paste the address and click Import. |
| HTTP/API | The service needs a token, API key, Basic login, custom headers, query parameters, or POST. |
If the file is already a public GeoJSON, GeoPackage, or ZIP URL, stay with URL. It is the simpler option.
Before you start¶
You need an http:// or https:// address that returns a spatial dataset GeoJibe can already inspect — for example GeoJSON, JSON that GeoJibe recognizes, CSV, KML, GML, GeoPackage, a ZIP Shapefile, or FlatGeobuf.
HTTP/API does not add new file formats. If inspect cannot read the response, import fails the same way a URL import would.
1. Add an HTTP/API Source¶
On the Canvas, add HTTP/API (after URL in Components).
In Properties:
- Choose a saved HTTP/API Source, or configure the request.
- Set Method to GET (the default) or POST.
- Enter the URL.
- Choose Authentication if the API requires it.
- Click Test to check the request without importing.
- Click Import.
On Classic, choose HTTP/API under or import from.
The Canvas card shows the saved name or host and the method (GET or POST). It never shows tokens, passwords, or full query strings.
2. Authentication¶
| Choice | What you enter | What GeoJibe sends |
|---|---|---|
| None | Nothing | No auth headers |
| Bearer Token | Token | Authorization: Bearer … |
| API Key | Key name, value, and Header or Query parameter | That header or query parameter |
| Basic Authentication | Username and password | Standard HTTP Basic |
Leave a saved token, API key, or password blank when editing to keep the stored value. GeoJibe does not show stored secrets again.
Do not add an Authorization header under Request options. Use Authentication instead. Duplicate Authorization is rejected.
3. Request options¶
Open Request options only when you need them:
- Query parameters (repeatable key/value rows)
- Headers (repeatable key/value rows)
- For POST: JSON body or Form fields
JSON bodies are checked before the request is sent. Multipart file upload, GraphQL, SOAP, and XML form builders are not part of this Source.
Examples¶
Public GeoJSON with GET¶
Method GET, URL https://api.example.com/neighborhoods.geojson, Authentication None. Click Import.
Bearer-authenticated API¶
Method GET, URL https://api.example.com/data, Authentication Bearer Token, then paste the token. Test, then Import.
API key in a header¶
Method GET, Authentication API Key. Key name X-API-Key, send in Header.
POST JSON request¶
Method POST, Body type JSON:
GeoJibe sends that JSON and imports the spatial response.
4. After Import¶
Inspect, Transform, Python, and Convert work the same as after a URL Import.
Typical workflows:
- HTTP/API → Transform → PostGIS
- HTTP/API → Convert → Download
Saved Jobs¶
Save the HTTP/API Source, then save the Job. Each run fetches a fresh response from the API. The Job does not store the downloaded file. Tokens stay in encrypted Source credentials, not in the Job definition.
Scheduled Jobs such as HTTP/API → Transform → PostGIS use the current API data every time.
Network policy¶
HTTP/API uses the same outbound rules as URL:
- Only http and https
- Local, loopback, link-local, private, and cloud metadata addresses are blocked
- Redirects (at most five) are checked the same way as the first URL
- TLS certificate verification stays on
This applies on Shared, Dedicated, and On-Site. Private APIs on a self-hosted network are not reachable through HTTP/API or URL. Use a Webhook Destination when GeoJibe must call a private endpoint you control, or import from PostGIS, S3, or Upload instead.
Administrators set size and timeout with the existing ENCIVA_URL_* settings. See Configuration.
Limits you might notice¶
- GET and POST only
- No OAuth, cookies, client certificates, or automatic pagination
- ArcGIS FeatureServer layers belong on the ArcGIS Source
- Large responses can time out or hit the download size cap
- Test reports status, content type, size, and filename — not the response body or any secrets
Having trouble?¶
See My HTTP/API request won't import.