Authentication

The Poli Page Go SDK authenticates every request with a bearer token. An API key belongs to one environment of your organization, and its text names that environment.

API keys

API keys and environments

An API key looks like pp_{env}_…, and the environment name in the key decides where the render goes. pp_sandbox_… renders in the sandbox: documents carry a watermark, do not count toward your quota, and expire 30 days after creation. pp_live_… and the keys of environments you create on a Pro plan (pp_{name}_…) render without a watermark and count toward your quota. Every key targets the same API host.

Pass the key to NewClient via option.WithAPIKey:

client := polipage.NewClient(
  option.WithAPIKey(os.Getenv("POLI_PAGE_API_KEY")),
)

The SDK never reads POLI_PAGE_API_KEY implicitly. You always pass the key in. It sends the key as is and never inspects or validates it.

Key format

A key is pp_{env}_ followed by 32 lowercase hex characters, where {env} is the environment’s name: 1-20 characters, lowercase letters, digits and single inner hyphens, starting with a letter. Standard and service keys share this format. A full key matches:

^pp_(?=[a-z][a-z0-9-]{0,19}_)[a-z][a-z0-9]*(?:-[a-z0-9]+)*_[0-9a-f]{32}$

Environments

Environment	Key	Watermark	Counted
sandbox (every org)	pp_sandbox_…	yes	no
live (every org, deletable on Pro+)	pp_live_…	no	yes
created on Pro+ (e.g. staging)	pp_staging_…	no	yes

“Counted” means the render counts toward the organization’s monthly PDF quota. sandbox documents are watermarked, are not counted and expire 30 days after creation. There is no watermark option: a template that wants a watermark outside sandbox uses the poli-watermark class.

A render uses the project’s copy published in the key’s environment. Every key uses the same endpoint, https://api.poli.page.

Example

package main

import (
  "os"

  "github.com/poli-page/sdk-go"
  "github.com/poli-page/sdk-go/option"
)

func main() {
  _ = polipage.NewClient(
    option.WithAPIKey(os.Getenv("POLI_PAGE_API_KEY")),
  )
}

See also

• Configuration
• Errors