Access and limits - eStream API Documentation

Overview

For enhanced security, the TeleMapper API allows you to restrict access based on IP addresses. By specifying allowed IPs, you can ensure that only requests from trusted networks are accepted.

How IP Restrictions Work

Allowlist:
Add one or more IP addresses or CIDR ranges to your account’s allowlist.
Enforcement:
Any API request from an IP not on the allowlist will be denied with an authentication error.
Management:
You can update your allowed IPs at any time through the developer dashboard or by contacting support.

Example Error Response

{
  "error": "Access denied. Your IP address is not authorized to use this API.",
  "success": false,
  "code": 429
}

Tip:
Use IP restrictions in combination with strong authentication for maximum protection.

Access

To start using the eStream API, you need to obtain an access token. This token authenticates your requests and determines your permissions and usage limits.

How to Request Access

Sign Up:
Register for an account on the eStream developer portal.
Submit an Access Request:
Fill out the API access form with your organization details and intended use case.
Approval Process:
Our team will review your request and notify you once your access is granted.
Receive Your Token:
After approval, you’ll receive an access token via email or in your developer dashboard.

Example Success Response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "success": true,
  "code": 200
}

Rate Limit

To ensure stability and fair usage, the TeleMapper API enforces rate limits per access token.

Plan	Requests	Time Window
QA	2,000	per hour
Standard	1,000	per hour
Partner	10,000	per hour

If your limit is exceeded, you’ll receive a 429 Too Many Requests response.

Example Error

{
  "code": 429,
  "success": false,
  "error": "Rate limit exceeded. Try again later."
}

Error Codes & Responses

The eStream uses consistent HTTP status codes for all responses.
Each code includes a clear message and optional error_code field for advanced integrations.

✅ Success Responses

Code	Meaning	Example	Notes
200	OK	Request processed successfully.	Most GET endpoints.
201	Created	A new resource has been created.	Used for `POST /recruitments`
202	Accepted	Request queued or batch accepted.	Used for `/batch` calls.

⚠️ Client Error Responses

Code	Meaning	Example Message	Resolution
400	Bad Request	Invalid or missing parameters.	Check JSON format or query parameters.
401	Unauthorized	Invalid or expired token.	Log in again using `/auth/token`.
403	Forbidden	Access denied.	Verify IP allowlist or role permissions.
404	Not Found	Resource not found.	Ensure the requested ID or path exists.
409	Conflict	Duplicate or conflicting record.	Adjust your request payload.

🚨 Server Error Responses

Code	Meaning	Example Message	Resolution
429	Too Many Requests	Rate limit exceeded.	Wait before retrying or reduce call frequency.
500	Internal Server Error	Unexpected error occurred.	Contact support with the request ID.
503	Service Unavailable	API temporarily down.	Retry after a few minutes.

🧾 Example JSON Response

{
  "status": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token"
}

​Overview

​How IP Restrictions Work

​Example Error Response

​Access

​How to Request Access

​Example Success Response

​Rate Limit

​Example Error

​Error Codes & Responses

​✅ Success Responses

​⚠️ Client Error Responses

​🚨 Server Error Responses

​🧾 Example JSON Response