Documentation Guide

This page describes the documentation available for the Arkose Bot Manager. Its organization matches the order in which you should read the documentation when getting started, with more esoteric and rarely referenced documentation at the end.

Implementation Guides

• Arkose Bot Manager Quickstart
  • Instructions for quickly getting a usable integration with Arkose Bot Manager up and running.
• Setting Up Arkose Bot Manager
  • Quick roadmap for setting up Arkose Bot Manager for your applications.
• Arkose Labs Command Center
  • The Arkose Command Center is your central hub for data insights and self-service functions for monitoring and managing applications protected by Arkose Bot Manager. Its customizable dashboards empower better understanding and attack mitigation on Arkose Bot Manager protected applications. This page explains how to use the Command Center.

Server-Side Setup

This section gives full details how to set up Arkose Bot Manager on your server-side.

• Server-Side Instructions
  • Provides an overview of why and how to use the Verify API to validate the Client API's response.
• Content Delivery Network Setup
  • Points to pages for using Arkose Bot Manager with a Content Delivery Network (CDN).
  • Arkose on Akamai - Reference Architecture
    • Akamai CDN Setup - Client Side
      • Client-side setup instructions when using Fastly.
    • Akamai CDN Setup - Server Side
      • Server-side setup instructions when using Fastly.
  • Arkose on Fastly - Reference Architecture
    • Server-side setup instructions when using Fastly.
  • Arkose on CloudFlare - Reference Architecture
    • Cloudflare CDN Setup - Client Side
      • Client-side setup instructions for setting up Cloudflare CDN.
    • Cloudflare CDN Setup - Server Side
      • Server-side setup instructions for setting up Cloudflare CDN.

Client-Side Setup

This section gives full details how to set up the Arkose Bot Manager on your client-side.

• Client-Side Instructions
  • Covers how to set up Arkose Bot Manager for web-based clients.
• Mobile
  • Brief overview of the different ways of setting up Arkose Bot Manager for mobile-based applications.
  • Android Mobile SDK
    • How to set up the preferred way of running Arkose Bot Manager on Android apps. The Android Mobile SDK lets you wrap our solution with Android native function calls.
  • iOS Mobile SDK
    • How to set up the preferred way of running Arkose Bot Manager on iOS apps. The iOS Mobile SDK lets you wrap our solution with iOS native function calls.
  • Android Native Setup
    • This page is about Arkose Labs' Webview direct integrations approach for Android. This approach requires you to write significant code yourself. We strongly urge you to use our Android Mobile SDK instead. New functionality is only added to the SDK.
  • iOS Native Setup
    • This page is about Arkose Labs' Webview direct integrations approach for iOS. This approach requires you to write significant code yourself. We strongly urge you to use our iOS Mobile SDK instead. New functionality is only added to the SDK.
• Specialized Setup
  • In addition to general Web Browser and Mobile platforms, there are some specialized cases that have specific setup instructions for Arkose Bot Manager.
  • Subresource Integrity (SRI)
    • SRI (Subresource Integrity) lets a browser verify that content delivered from a third party is valid and has not been altered. This page explains how to enable SRI for your Arkose Bot Manager implementation.
  • Iframe Setup Guide
    • Shows details of how to set up and use the Arkose Bot Manager in the context of an iframe.
  • Angular Setup Guide
    • Describes how to use the Arkose Bot Manager with single page applications built using Angular.
  • React or Angular Setup Guide
    • Describes how to use the Arkose Bot Manager with single page applications built using frameworks such as React and Angular.
  • Connected Devices Integration
    • Discusses how to integrate web connected devices, such as gaming consoles and smart TVs, with Arkose Bot Manager.
  • reCAPTCHA to Arkose Labs Migration Guide.
    • How to migrate from using reCAPTCHA to using Arkose Bot Manager.
  • New Enforcement Challenge UI
    • Overview and requirements of the new Enforcement Challenge UI.
  • Using Auth0 and Arkose for New Account Registration
    • Shows a high level overview of how to integrate Arkose Bot Manager directly via the Auth0 development console.

Arkose Labs APIs

This section covers the various Arkose APIs, including tutorial material on what they do and how to use them, and reference material on how to call them and descriptions of their request and response fields.

• Arkose Labs API Guide
  • Brief descriptions of the APIs.

Client API

• Client API
  • Overview of how to use the Client API, descriptions of what callbacks you need to write code for and when they are triggered.
• Callbacks
• Configuration Object
  • Listing and description of values in the Configuration Object used to configure Arkose Bot Manager Client API.
• Response Object (onCompleted, onError, onFailed, onResize)
  • Describes the Response Object used by several callbacks after either detection or enforcement is completed or an error occurred during either one.

Verify API

• Verify API v4
  • Overview of what the Verify API does, when to call it, and how to process call responses.
  • Calling Verify v4 API
    • Covers available ways to make a Verify call.
  • Verify Request and Response Schemas
    • JSON descriptions of Verify request and response schema definitions.
  • Verify API v4 Response Fields and Examples
    • Annotated descriptions of the Verify response fields.
  • IP Velocity Fields
    • As an optional feature, you can add Verify response fields that provide information about IP velocity. This page tells you how to do so and describes the additional response fields.
  • Risk Score
    • As an optional feature, you can add Risk Scores, calculated from telltale data, to Verify response fields. This page tells you how to do so and describes the additional response fields.
  • Migrating to Verify v4 from v1, v2, v3
    • How to migrate from Verify v1, v2, or v3 and key differences between the versions.
  • Enhanced Error Codes
    • Show default error responses returned by Verify v4.

Truth Data

• Truth Data System
  • Provides an overview and walkthrough of Arkose Labs Truth Data system which lets you provide feedback to Arkose via the Arkose Labs Command Center.

General Support and Status

This section has two pages, which cover:

• General Support and Bug Bounty:
  • This page tells you:
    • How and where to get Support for Arkose Bot Manager.
    • How to use our Bug Bounty program.
• Troubleshooting, API Status, and Health Checks
  • This page tells you:
    • How to check on whether the Arkose Labs APIs are up.
    • How to see regional health checks.
    • How to troubleshoot problems with Arkose Bot Manager.
    • How to handle errors you may encounter.
  • Client-Side Error Handling
    • This page describes the following callbacks and error codes:
      • onError callback: Can be used to listen for occurrences of errors in our platform and allow the customer to take action when they occur
      • Error Codes: Values that could be passed to the onError callback.
      • onerror script: By listening to this callback a customer is able to catch any error that may occur during the loading of the initial api.js javascript file.

Accessibility

• Accessibility Conformance Report:
  • This Accessibility Conformance Report is based on the standard Voluntary Product Accessibility Template (VPAT). It outlines Arkose Labs' conformance with Section 508 of the Rehabilitation Act and the Web Content Accessibility Guidelines (WCAG).
• Assistive Technology Support:
  • Specifies which assistive technologies are supported for Arkose Bot Manager components. Included are
    • Supported Browser and Screen Reader Combinations - Desktop and Laptop and Mobile
    • Screen Magnification
    • Electronic Braille Displays
    • Support for Alternative Input Devices

What We Support and Use

This section, at the end of the left sidebar menu, contains reference material for what browsers and languages (natural, not computer) the Arkose Bot Manager supports.

• Support and Use Overview
  • Descriptions of the pages under General Support and Status and What We Support and Use.
• Supported Languages
  • Arkose Bot Manager's Enforcement Challenge (EC) can be invoked in many languages. This page has a list of available languages for both text-based and audio-based ECs. It also has instructions for how to configure the Arkose client to use a particular language instead of the default use of browser settings to determine the language.
• Supported Browsers
  • Specifies which browsers are supported for the different Arkose Bot Manager components, including desktop, mobile, connected devices, and the Arkose Command Center.
• Domain Policy
  • Specifies what domains the Arkose Bot Manager uses.
• Product EOL Communications
  End of life communications to inform customers about the discontinuation of products and the availability of support and alternative solutions.