yaan

https://yaan.ch/docs
Admin
yaan is an anti-bot and web security service that protects websites by verifying user tokens and...
Tokens:2,847
Snippets:64
Trust Score:4.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize yaan Browser SDK

Source: https://yaan.ch/docs/info/browser-sdk

Add this script tag to your HTML to load the SDK. Replace YOUR_SITEKEY with the key provided in your dashboard.

```html
<script type="module" src="https://leaf.yaan.ch/leaf.js?k=YOUR_SITEKEY"></script>
```

--------------------------------

### Integration Script

Source: https://yaan.ch/docs/info/browser-sdk

How to include the yaan Browser SDK in your HTML.

```APIDOC
## Integration Script

### Description
Embed the yaan SDK by adding the following script tag to your HTML.

### Script
<script type="module" src="https://leaf.yaan.ch/leaf.js?k=YOUR_SITEKEY"></script>

### Parameters
- **k** (string) - Required - The sitekey (starts with sk_) obtained from your dashboard.
```

--------------------------------

### window.apricot.verify()

Source: https://yaan.ch/docs/info/browser-sdk

The primary method for initiating a bot protection verification process.

```APIDOC
## window.apricot.verify()

### Description
Initiates the bot protection verification process. Only one verification can run at a time.

### Returns
- **Promise** - Resolves with a verification token.

### Throws
- If the sitekey is missing.
- If the module fails to load.
- If a verification is already in progress.
```

--------------------------------

### Public API Endpoint

Source: https://yaan.ch/docs/info/sus

This section details the public API endpoint for validation services.

```APIDOC
## POST /v1/sus

### Description
This endpoint is used for public validation services.

### Method
POST

### Endpoint
https://apricot.yaan.ch/v1/sus

### Schemas
#### Request Body
- **ValidateRequest** (object) - Required - Represents the request object for validation.
  - **ValidateRequestContext** (object) - Required - Contextual information for the validation request.
  - **ValidateRequestHeaders** (object) - Required - Headers associated with the validation request.

#### Response Body
- **ValidateResponse** (object) - Represents the response object from validation.
  - **ValidateResponseIPInfo** (object) - Information about the IP address.
  - **ValidateResponseNetwork** (object) - Network-related information.
  - **ValidateResponsePrivacy** (object) - Privacy-related information.
```
Tokens:
Raw