Getting Started
Prerequisites
Before using the EAI, you will need:
- An active Teleskope tenant with a company subdomain (e.g., yourcompany.teleskope.io)
- EAI credentials (username and password/client secret) provisioned by your Teleskope account manager
Setup Steps
- Obtain credentials — Contact your Teleskope account manager to request EAI credentials for your tenant
- Configure permissions — Your account manager will set up the appropriate permissions for the endpoints you need access to
- Optionally configure IP whitelisting — Restrict API access to specific IP addresses or CIDR ranges for additional security
- Authenticate — Use either OAuth2 Bearer tokens or HTTP Basic Auth to authenticate your requests
- Start integrating — Call the API endpoints as documented in the API Reference
Base URL
All endpoints are accessed via your company subdomain:
https://{subdomain}.teleskope.io/1/eai/Replace {subdomain} with your organization's Teleskope subdomain (provided by your account manager).
Endpoint Routing (Graph API)
The Graph API uses query-parameter-based routing. Each operation is triggered by a specific query parameter on /1/eai/graph.php.
For example, to list zones:
GET https://yourcompany.teleskope.io/1/eai/graph.php?listZonesOfAppType=affinitiesResponse Format
All Graph API endpoints return JSON with a consistent structure:
{
"status": true,
"message": "Description of result",
"data": [ ... ]
}Field | Type | Description |
|---|---|---|
status | boolean | true for successful requests, false for errors |
message | string | Human-readable description of the result |
data | array or object | Response payload, or null on error |
ID Encoding
All resource IDs returned by the API are encoded. You must use the encoded IDs exactly as returned when passing them as parameters to other endpoints. Never attempt to decode or construct IDs manually.