Skip to main content

​
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.
Authentication Flow

​
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

  1. Sign Up:
    Register for an account on the eStream developer portal.
  2. Submit an Access Request:
    Fill out the API access form with your organization details and intended use case.
  3. Approval Process:
    Our team will review your request and notify you once your access is granted.
  4. 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.
PlanRequestsTime Window
QA2,000per hour
Standard1,000per hour
Partner10,000per hour
If your limit is exceeded, you’ll receive a 429 Too Many Requests response. Authentication Flow

​
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

CodeMeaningExampleNotes
200OKRequest processed successfully.Most GET endpoints.
201CreatedA new resource has been created.Used for POST /recruitments
202AcceptedRequest queued or batch accepted.Used for /batch calls.

​
⚠️ Client Error Responses

CodeMeaningExample MessageResolution
400Bad RequestInvalid or missing parameters.Check JSON format or query parameters.
401UnauthorizedInvalid or expired token.Log in again using /auth/login.
403ForbiddenAccess denied.Verify IP allowlist or role permissions.
404Not FoundResource not found.Ensure the requested ID or path exists.
409ConflictDuplicate or conflicting record.Adjust your request payload.

​
🚨 Server Error Responses

CodeMeaningExample MessageResolution
429Too Many RequestsRate limit exceeded.Wait before retrying or reduce call frequency.
500Internal Server ErrorUnexpected error occurred.Contact support with the request ID.
503Service UnavailableAPI temporarily down.Retry after a few minutes.

​
🧾 Example JSON Response

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