Skip to main content

โ€‹
1. API Language Selection

๐ŸŒ Use the Accept-Language header to receive API messages in different languages for login-free endpoints (any call that does not require an access token). Supported values are shown below, so pick what your automation prefers. ๐ŸŽฏ 
Accept-Language: tr
Accept-Language: en

โ€‹
Login-free API endpoints ๐Ÿ”“

  • Authorization Service โš™๏ธ
    • New User Registration - /v1/auth/register
    • Login Process - /v1/auth/login
    • Access Token Refresh - /v1/auth/refresh
  • User Service ๐Ÿ‘ฅ
    • Password Reset Request /v1/users/password-reset-request

โ€‹
User Language Selection

After a user logs in, the system reads the locale and language embedded inside the Access Token and automatically localizes the responses. Additionally, the User Update endpoint /v1/users/update lets a user (or an ADMIN acting for others) adjust language, locale, and timezone settings with a single call. ๐Ÿ› ๏ธ๐ŸŒŽ

โ€‹
2. User Registration and Account Activation

1

New User Registration

  • A new user registration is created via the New User Registration - /v1/auth/register API endpoint by providing the following information:
    1. Username (email address)
    2. Password
    3. Name
    4. Middle Name, if any
    5. Surname
    6. Language and Locale Preference
    7. Time Zone Preference
  • If another user already exists with the same username (email), the API responds with 400 - Bad Request and Existing User. ๐Ÿšซ
  • Successful registrations are created with the INACTIVE status until activation is complete. โณ
2

Account Activation Request

  • Submit an activation request via Account Activation Request - /v1/accounts/account-activation-request by providing:
    1. User ID
    2. Account Type
    3. Mobile Phone Number
    4. Location Address
    5. Company
    6. Industry
    7. Link to Account Activation Page
  • The endpoint validates the payload (e.g., whether the user already has an account), creates the account when valid, and emails the activation link to the user. โœ‰๏ธ
3

Account Activation

  • It finalizes the registration of a new account via the Account Activation - /v1/accounts/activate-account API endpoint by entering the following information:
    1. User ID
    2. Account ID
    3. Email Verification Token
  • Activates a user account by verifying the provided email verification token. It validates the token, updates account and user status, and ensures the token has not expired. ๐Ÿ”
  • Once verified, the account is marked as email verified and token fields are cleared. โœ…
4

Mobile Phone Number Verification Request

A phone number verification request is made via the Mobile Phone Number Activation Request - /v1/accounts/phone-number-activation-request API endpoint by entering the following information:
  1. User ID
  2. Account ID
  3. Link to Phone Number Activation Page
  • Handles the activation process for a userโ€™s phone number. This includes validating the account, generating a phone number verification token, composing an activation message, and sending the activation SMS. ๐Ÿ“ฒ
  • It is an optional step, this and the next step can be skipped, but the user will not receive SMS notifications if the phone number is not verified. ๐Ÿšซ
5

Mobile Phone Number Verification

The phone number verification process is finalized by entering the following information via the Mobile Phone Number Activation - /v1/accounts/activate-phone-number API endpoint:
  1. User ID
  2. Account ID
  3. Phone Number Validation Token
  • Activates a phone number for a user by verifying the provided phone number verification token associated with their account. ๐Ÿ”
6

Subscription Selection

The user cannot use paid services unless a subscription is selected, so complete the next section right after activation. ๐Ÿ’ก

โ€‹
3. Subscription Operations

  • Use Update Subscription - /v1/accounts/update-subscription to manage the plan for a user account by supplying:
    • Plan Selection
      1. User ID
      2. Subscriber ID
      3. Subscription Plan Name
    • Creating a Custom Plan
      1. User ID
      2. Subscriber ID
      3. Plan Details
        1. Subscription Period
        2. Limit Reset Recurrence
        3. Geographical Boundary
        4. API Service Limits
          1. API Version
          2. API Endpoint Name
          3. Maximum Number of Calls
  • The endpoint validates roles and account existence, sets the subscription plan, adjusts statuses if needed, and returns clear validation errors whenever something is missing. โœ…๐Ÿ“ฌ

โ€‹
3.1. Subscription Plans ๐Ÿ“ฆ

PlanPeriodLimit ProfileGeo ScopeQuick Notes
None-No quota appliedNot applicableDefault state for users without an active subscription.
Trial1 monthDaily cap: 5 calls, very low throughputAll regionsOne-time trial per userโ€”ideal for evaluations.
Basic - Monthly1 monthMonthly reset, limit count 1, restricted volumeAll regionsBudget-friendly option; renew every month to keep access.
Basic - Annual1 yearAnnual quota pool with limited total callsAll regionsSpend the yearly bucket anytime within the year.
Premium - Monthly1 monthMonthly reset, higher allowanceAll regionsTop-tier monthly access; renew each month.
Premium - Annual1 yearAnnual quota with generous limitsAll regionsFull-year premium bundle, use quota flexibly.
CustomConfigurableAdjustable period, limit type, and call capsCountry/region boundaries configurableTailor every parameter (limits, geography, API mix) to match bespoke contracts.

โ€‹
3.2. Geo-bounding Options for Custom Subscription Option ๐Ÿ—บ๏ธ

  1. All
  2. Akdeniz Region
  3. DoฤŸu Anadolu Region
  4. Ege Region
  5. GรผneydoฤŸu Anadolu Region
  6. ฤฐรง Anadolu Region
  7. Marmara Region
  8. Karadeniz Region