Documentation

Docs home: https://docs.skyfire.xyz/docs/getting-started
API reference: https://docs.skyfire.xyz/reference/skyfire-apis
Reference implementations (these include open source code repos and live demos that you can run yourself)
- Data purchase via API: https://docs.skyfire.xyz/docs/skyfire-solutions-demo-on-github
- Paid web crawling: https://docs.skyfire.xyz/docs/access-to-protected-premium-web-content-by-a-paying-web-crawler-1

KYAPay tokens

Current token schema: https://docs.skyfire.xyz/docs/token-schemas
You can also see the token schemas in the live demos, above, and also in the Playground once you create an account
- https://docs.skyfire.xyz/docs/buyer-onboarding

Integration testing environment (sandbox)

For integration testing, you can temporarily use our PRD environment. We will soon have a Sandbox environment for you.

App: https://app-sandbox.skyfire.xyz
API: https://api-sandbox.skyfire.xyz
MCP server: https://mcp-sandbox.skyfire.xyz

NOTE: In Sandbox your Seller services are auto-approved and activated on creation and update. However, in Production your Seller services must be approved by Skyfire. Please email us your Seller Service ID from your account email address.

Setup

Setup your Skyfire account: https://docs.skyfire.xyz/docs/introduction
Create a test buyer agent so you can test e2e yourself: https://docs.skyfire.xyz/docs/getting-started-2
Create a test seller agent and test seller service to receive your test buyer's tokens and inspect / charge them: https://docs.skyfire.xyz/docs/creating-a-seller-account

Integration

Once you have your buyer agent and seller agent setup and have created API keys

Creating a token is a single API call - https://docs.skyfire.xyz/reference/create-token
- Example: https://github.com/skyfire-xyz/skyfire-solutions-smart-web-crawler-demo/blob/fee2df5580b84060139a3a0299cb4a25ab456291/crawler-bot-protection-proxy/scripts/create-token.ts#L138
Inspecting a token is standard JWKS - https://docs.skyfire.xyz/reference/verify-and-optionally-extract-data-from-the-tokens
- Example: https://github.com/skyfire-xyz/skyfire-solutions-smart-web-crawler-demo/blob/fee2df5580b84060139a3a0299cb4a25ab456291/crawler-bot-protection-proxy/src/middleware/verify-header.ts#L15
(optionally) Chargng a "pay" or a "kya+pay" token is a single API call - https://docs.skyfire.xyz/reference/charge-token
- Example: https://github.com/skyfire-xyz/skyfire-solutions-smart-web-crawler-demo/blob/fee2df5580b84060139a3a0299cb4a25ab456291/crawler-bot-protection-proxy/src/services/skyfire-api.ts#L17
For integration on the seller side, you can also refer to: https://docs.skyfire.xyz/reference/integrating-kyapay-tokens-into-your-seller-services
On the buyer side, you can also use our MCP Server: https://docs.skyfire.xyz/reference/using-the-skyfire-mcp-server

Production deployment

Currently we do not have an automated way to promote your account and settings from Sandbox to Production. You will need to create a Production Account and configure it again in Production.