{s}crubl

{s}crubl API Documentation

Scrubl is an API service for generating privacy and security compliance safe text. You can think of it as a text sanitizer for the privacy era. The API follows the REST convention and returns JSON eoncoded responses.

The primary purpose of the API is to scrub text blocks, removing a variety of undesired information. Each word you send to the API will count as one API request. Once you have used all included requests in the current month, the API will respond with a 403 Over Limit Status.

Versioning and Endpoint Root

The Scrubl API is versioned, and you can target the version you wish to integrate with body incorporating the version in the URL of your requests. From time to time we release new versions of the API, and may deprecate older versions.

https://scrubl.com/api/v1

Getting Started

To get started with Scrubl, you will need an API key. This can be obtained for free at https://scrubl.com.

Next, you will select (or create) scrubbers which target specific data elements and group them together in a project. Use the project Endpoint to clean up text.

Authentication

The Scrubl API uses an API key to authenticate your requests. When you signed up with Scrubl, and API key was automatically created and assigned to your account. You can find this on your Dashboard.

When you send a request to the Scrubl API, you will need to include this API key in your HEADER as follows:

X-Token: 'your-api-token'

All API requests are made over HTTPS. Calls made without the API key passed in the header will fail with 401 Could not Authenticate

Scrub Endpoint

The scrub endpoint is used to scrub text and will replace or mask any data elements associated with the project referenced in the request. To scrub a block of text, send a request to the following endpoint:

POST https://scrubl.com/api/v1/projects/scrub

Note:
Scrubl does not store or retain the text you send to the API.

Request Parameters

The request should contain the following parameters:

project_id string
The ID of the project you want to use to scrub this text

text string
The text that will be scrubbed

Sample Request


{
  project_id: 'your-project-id',
  text: 'the text containing what you want to scrub'
}

Response

The response will include the following params

original_text string
The text you submitted to the API

scrubbed_text string
The scrubbed and masked text

project_id string
The project_id representing the project used by the scrubber

request_ip string
The IP the request was sent from

words_scanned integer
The number of words scrubbed.

run_time decimal
The amount of time the service spent preparing this request.

api_calls integer
The number of API calls this request used.

scrubbers text
The specific scrubbers used.

Sample Response


{
  "original_text": "the text containing what you want to scrub",
  "scrubbed_text": "the text containing what you want to scrub",
  "project": "your-project-id",
  "request_ip": "your.ip.addr.here",
  "words_scanned": 300,
  "run_time": .00431,
  "api_calls": 600,
  "scrubbers": "ip address, email address"
}