Quickstart

This guide walks through the minimum NexaLayer flow:

API Key -> products -> create session -> proxy.full_url -> report result -> read health -> terminate session

1. Request an API key by email

BASE_URL="https://api.nexalayer.net/v1"

curl -X POST "$BASE_URL/account/request-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@example.com"
  }'

The response does not include the API key. NexaLayer sends it to the mailbox:

{
  "data": {
    "status": "email_sent",
    "balance": 0,
    "backend_ready": true,
    "message": "If the email address is valid, the API key has been sent."
  }
}

The first request for a new email automatically receives a small one-time trial credit. Repeating the request resends the existing API key and never grants credit twice. No Telegram or manual approval is required.

export NEXALAYER_API_KEY="ak_xxx"

2. List products

curl "$BASE_URL/products?type=dynamic" \
  -H "X-API-Key: $NEXALAYER_API_KEY"

Use the returned product_no when creating a session. Dynamic products work well for short-lived and rotation-friendly automation. Static products are better for stable identity, account login, and fixed-region tasks.

3. Create a dynamic session

PRODUCT_NO="dynamic_dyn3"

curl -X POST "$BASE_URL/sessions" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $NEXALAYER_API_KEY" \
  -H "Idempotency-Key: create-dynamic-001" \
  -d "{
    \"session_type\": \"dynamic\",
    \"product_no\": \"$PRODUCT_NO\",
    \"provisioning_mode\": \"existing\",
    \"quantity\": 0.25,
    \"protocol\": \"socks5\",
    \"rotation_mode\": \"on_demand\"
  }"

provisioning_mode=existing attaches a resource already configured by support without placing an order or charging balance. Use purchase after recharging when you want to buy a new resource. Prices and balance are displayed in USD using IPProxy’s current effective exchange rate; NexaLayer does not make a second debit. Session creation is asynchronous. A successful accepted response usually starts with status=creating.

4. Poll until active

SID="sess_xxx"

curl "$BASE_URL/sessions/$SID" \
  -H "X-API-Key: $NEXALAYER_API_KEY"

When the session becomes active, the response includes proxy details:

{
  "data": {
    "session_id": "sess_xxx",
    "status": "active",
    "proxy": {
      "host": "proxy.example.net",
      "port": 6666,
      "username": "user",
      "password": "pass",
      "protocol": "socks5",
      "full_url": "<redacted-proxy-url>"
    }
  }
}

proxy.full_url can be used by tools that accept proxy URLs. Playwright usually needs server, username, and password separately.

5. Report execution telemetry

curl -X POST "$BASE_URL/sessions/$SID/report-event" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $NEXALAYER_API_KEY" \
  -d '{
    "event_type": "success",
    "status_code": 200,
    "target_host": "example.com",
    "latency_ms": 1200
  }'

Telemetry affects health score and rotation recommendations.

6. Read health

curl "$BASE_URL/sessions/$SID/health" \
  -H "X-API-Key: $NEXALAYER_API_KEY"

Example:

{
  "data": {
    "health_score": 100,
    "risk_level": "low",
    "success_rate": 1,
    "consecutive_failures": 0,
    "recommendation": "ok"
  }
}

7. Terminate the session

curl -X DELETE "$BASE_URL/sessions/$SID" \
  -H "X-API-Key: $NEXALAYER_API_KEY"

Automation scripts should clean up sessions in a finally block or shutdown hook.

中文

English

Reference

Quickstart

Quickstart

1. Request an API key by email

2. List products

3. Create a dynamic session

4. Poll until active

5. Report execution telemetry

6. Read health

7. Terminate the session

​Quickstart

​1. Request an API key by email

​2. List products

​3. Create a dynamic session

​4. Poll until active

​5. Report execution telemetry

​6. Read health

​7. Terminate the session

Quickstart

1. Request an API key by email

2. List products

3. Create a dynamic session

4. Poll until active

5. Report execution telemetry

6. Read health

7. Terminate the session