Quick Start

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

The first step is to create a user account through the Clearinghouse website, https://clearinghouse.net/registration. Then you can request an API key, https://www.clearinghouse.net/api-request.

Once the request is accepted, you will receive an email from [e-mail] with your token.

Authentication

There are two methods of authentication CRLCA has available:

• Token Authentication

• Session Authentication

The following sections will go over how to make your first request using both authentication methods.

Token Authentication - Make your first request

Token authentication authenticates based the token you have received via email from [e-mail].

To make your first request, send an authenticated request to the hello endpoint.

Get test.

GET https://www.clearinghouse.net/api/v1/test

Test endpoint for API connection verification

Headers

Name	Type	Description
Authorization*	String	Authorization Token XXXXXXXXXXX where XXXXXXXXXXX is the token string

200 Successfully connected

{
"message": "Success, you have access to the Civil Rights Clearinghouse Litigation API!"
}

401 Permission denied

{
    "detail":"Authentication credentials were not provided."
}

Take a look at how you might call this method using python or curl:

python

import requests

url = "https://clearinghouse.net/api/v1/test"
payload = {}
headers = { 'Authorization': 'Token XXXXXXXXXX',
'User-Agent': 'Chrome v22.2 Linux Ubuntu'
}
response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

curl

curl https://www.clearinghouse.net/api/v1/test/ 
    -H 'Authorization: Token XXXXXXXXXXXXXXX'

Session Authentication

Session authentication authenticates based on your Civil Rights Clearinghouse Litigation website login credentials.

Recommendation: Session authentication is a great way to navigate available CRCLA requests using the web browser.

To make your first request, make sure you are logged onto your Civil Rights Clearinghouse Litigation account. You can access the authentication request to the following endpoint: https://www.clearinghouse.net/api/v1/test.

You should see the following the data returned:

{ "message": "Success, you have access to the Civil Rights Clearinghouse Litigation API!"