# Common patterns: Private pages

## Table of Contents

- [Choose the right header path PRO](#choose-the-right-header-path-pro)
- [Non-sensitive headers PRO](#non-sensitive-headers-pro)
  - [CLI Microlink API example](#cli-microlink-api-example)
  - [cURL Microlink API example](#curl-microlink-api-example)
  - [JavaScript Microlink API example](#javascript-microlink-api-example)
  - [Python Microlink API example](#python-microlink-api-example)
  - [Ruby Microlink API example](#ruby-microlink-api-example)
  - [PHP Microlink API example](#php-microlink-api-example)
  - [Golang Microlink API example](#golang-microlink-api-example)
- [Sensitive headers and cookies PRO](#sensitive-headers-and-cookies-pro)
- [Use the SDK from the server](#use-the-sdk-from-the-server)
- [Use the correct endpoint](#use-the-correct-endpoint)
- [Keep credentials out of the browser](#keep-credentials-out-of-the-browser)
- [Proxy for blocked or geofenced sites PRO](#proxy-for-blocked-or-geofenced-sites-pro)
  - [CLI Microlink API example](#cli-microlink-api-example-1)
  - [cURL Microlink API example](#curl-microlink-api-example-1)
  - [JavaScript Microlink API example](#javascript-microlink-api-example-1)
  - [Python Microlink API example](#python-microlink-api-example-1)
  - [Ruby Microlink API example](#ruby-microlink-api-example-1)
  - [PHP Microlink API example](#php-microlink-api-example-1)
  - [Golang Microlink API example](#golang-microlink-api-example-1)

---

These authentication patterns apply to every Microlink workflow: screenshots, PDFs, data extraction, metadata, and insights. Each guide's own private pages section covers workflow-specific examples; this page covers the shared patterns.

## Choose the right header path PRO

| Situation                                           | Use                              | Why                                              |
| --------------------------------------------------- | -------------------------------- | ------------------------------------------------ |
| Language, user-agent, or other non-sensitive values | `headers` parameter              | Fine when the value is safe to expose in the URL |
| Cookies, bearer tokens, or secrets                  | `x-api-header-*` request headers | Keeps credentials out of the public query string |

Both approaches require a

PRO

plan.

## Non-sensitive headers PRO

Use `headers` when the value is safe to appear in the URL:

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://example.com' URL with 'headers' & 'apiKey' API parameters:

### CLI Microlink API example

```bash
microlink https://example.com&headers.Accept-Language=es-ES --api-key YOUR_API_TOKEN
```

### cURL Microlink API example

```bash
curl -G "https://pro.microlink.io" \
  -H "x-api-key: YOUR_API_TOKEN" \
  -d "url=https://example.com" \
  -d "headers.Accept-Language=es-ES"
```

### JavaScript Microlink API example

```javascript
import createClient from 'microlink.io'

const microlink = createClient({ apiKey: "YOUR_API_TOKEN" })

const data = await microlink.metadata('https://example.com', {
  headers: {
    "x-api-header-accept-language": "es-ES"
  }
})
```

### Python Microlink API example

```python
import requests

url = "https://pro.microlink.io/"

querystring = {
    "url": "https://example.com",
    "headers.Accept-Language": "es-ES"
}

headers = {
    "x-api-key": "YOUR_API_TOKEN"
}

response = requests.get(url, params=querystring, headers=headers)

print(response.json())
```

### Ruby Microlink API example

```ruby
require 'uri'
require 'net/http'

base_url = "https://pro.microlink.io/"

params = {
  url: "https://example.com",
  headers.Accept-Language: "es-ES"
}

uri = URI(base_url)
uri.query = URI.encode_www_form(params)

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['x-api-key'] = "YOUR_API_TOKEN"
response = http.request(request)

puts response.body
```

### PHP Microlink API example

```php
<?php

$baseUrl = "https://pro.microlink.io/";

$params = [
    "url" => "https://example.com",
    "headers.Accept-Language" => "es-ES"
];

$query = http_build_query($params);
$url = $baseUrl . '?' . $query;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_TOKEN"
    ]
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #: " . $err;
} else {
    echo $response;
}
```

### Golang Microlink API example

```
package main

import (
    "fmt"
    "net/http"
    "net/url"
    "io"
)

func main() {
    baseURL := "https://pro.microlink.io"

    u, err := url.Parse(baseURL)
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("url", "https://example.com")
    q.Set("headers.Accept-Language", "es-ES")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest("GET", u.String(), nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("x-api-key", "YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(body))
}
```

```javascript
importcreateClientfrom'microlink.io'

constmicrolink=createClient({apiKey:"YOUR_API_TOKEN"})

constdata=awaitmicrolink.metadata('https://example.com',{

headers:{

"x-api-header-accept-language":"es-ES"

}

})
```

Good for locale and request shaping. Avoid putting cookies or authorization tokens here because query parameters are public.

## Sensitive headers and cookies PRO

For cookies, authorization tokens, or any other secret, pass the value as an HTTP header on the Microlink request itself using the `x-api-header-*` prefix:

```bash
curl-Ghttps://pro.microlink.io\

-durl=https://example.com/dashboard\

-H'x-api-key: YOUR_API_TOKEN'\

-H'x-api-header-cookie: session=abc123'\

-H'x-api-header-authorization: Bearer YOUR_BEARER_TOKEN'
```

Microlink strips the `x-api-header-` prefix and forwards the original header to the target page. Any header can be forwarded this way:

- `x-api-header-cookie`
- `x-api-header-authorization`
- `x-api-header-x-my-custom-header`

## Use the SDK from the server

Keep credentials in the `headers` option — the SDK sends them as real HTTP request headers, never in the URL:

```js
importcreateClientfrom'microlink.io'

constmicrolink=createClient({

apiKey:process.env.MICROLINK_API_KEY

})

const{title,description}=awaitmicrolink.metadata(

'https://example.com/dashboard',

{

headers:{

'x-api-header-accept-language':'es-ES',

'x-api-header-cookie':`session=${process.env.SESSION_COOKIE}`

}

}

)
```

See the [SDK options](https://microlink.io/docs/sdk/getting-started/options) for more on `headers`.

## Use the correct endpoint

- `https://api.microlink.io` — unauthenticated, free-tier requests.
- `https://pro.microlink.io` — authenticated requests with `x-api-key`.

If you send `x-api-key` to the free endpoint, the request fails with `EPRO`. See the [endpoint docs](https://microlink.io/docs/api/basics/endpoint) and [authentication docs](https://microlink.io/docs/api/basics/authentication).

## Keep credentials out of the browser

Do not expose API keys, cookies, or authorization headers in client-side code or public embed URLs.

- Keep authenticated requests on your backend whenever possible.
- Use [@microlink/proxy](https://github.com/microlinkhq/proxy) for self-hosted protection.
- Use [@microlink/edge-proxy](https://github.com/microlinkhq/edge-proxy) for edge-deployed protection.

This is especially important when you use `embed` in public markup, because the full URL can end up in HTML source, logs, or browser devtools.

## Proxy for blocked or geofenced sites PRO

When the target site blocks headless browsers, geofences content, or triggers antibot protection, use `proxy`:

The following examples show how to use the Microlink API with CLI, cURL, JavaScript, Python, Ruby, PHP & Golang, targeting 'https://example.com' URL with 'proxy' & 'apiKey' API parameters:

### CLI Microlink API example

```bash
microlink https://example.com&proxy.url=https://myproxy:603f60f5@superproxy.cool:8001 --api-key YOUR_API_TOKEN
```

### cURL Microlink API example

```bash
curl -G "https://pro.microlink.io" \
  -H "x-api-key: YOUR_API_TOKEN" \
  -d "url=https://example.com" \
  -d "proxy.url=https://myproxy:603f60f5@superproxy.cool:8001"
```

### JavaScript Microlink API example

```javascript
import createClient from 'microlink.io'

const microlink = createClient({ apiKey: "YOUR_API_TOKEN" })

const data = await microlink.metadata('https://example.com', {
  proxy: {
    url: "https://myproxy:603f60f5@superproxy.cool:8001"
  }
})
```

### Python Microlink API example

```python
import requests

url = "https://pro.microlink.io/"

querystring = {
    "url": "https://example.com",
    "proxy.url": "https://myproxy:603f60f5@superproxy.cool:8001"
}

headers = {
    "x-api-key": "YOUR_API_TOKEN"
}

response = requests.get(url, params=querystring, headers=headers)

print(response.json())
```

### Ruby Microlink API example

```ruby
require 'uri'
require 'net/http'

base_url = "https://pro.microlink.io/"

params = {
  url: "https://example.com",
  proxy.url: "https://myproxy:603f60f5@superproxy.cool:8001"
}

uri = URI(base_url)
uri.query = URI.encode_www_form(params)

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['x-api-key'] = "YOUR_API_TOKEN"
response = http.request(request)

puts response.body
```

### PHP Microlink API example

```php
<?php

$baseUrl = "https://pro.microlink.io/";

$params = [
    "url" => "https://example.com",
    "proxy.url" => "https://myproxy:603f60f5@superproxy.cool:8001"
];

$query = http_build_query($params);
$url = $baseUrl . '?' . $query;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_TOKEN"
    ]
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #: " . $err;
} else {
    echo $response;
}
```

### Golang Microlink API example

```
package main

import (
    "fmt"
    "net/http"
    "net/url"
    "io"
)

func main() {
    baseURL := "https://pro.microlink.io"

    u, err := url.Parse(baseURL)
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("url", "https://example.com")
    q.Set("proxy.url", "https://myproxy:603f60f5@superproxy.cool:8001")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest("GET", u.String(), nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("x-api-key", "YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(body))
}
```

```javascript
importcreateClientfrom'microlink.io'

constmicrolink=createClient({apiKey:"YOUR_API_TOKEN"})

constdata=awaitmicrolink.metadata('https://example.com',{

proxy:{

url:"https://myproxy:603f60f5@superproxy.cool:8001"

}

})
```

Use a proxy URL when the target site blocks automation, needs a specific region, or rate-limits your origin.

If the API returns `EPROXYNEEDED`, that is the clearest signal that the target needs a proxy-backed request. See the [proxy reference](https://microlink.io/docs/api/parameters/proxy).