Authentication

When making API requests, authentication is required in order to verify the permissions of the caller. Authentication is handled via API keys.

Key Management

Your organization will be provided with your own API key for accessing Pearl’s Real Estate API resources.

Using your API Key

The API Key is used for token-based authentication. To use token-based authentication, you’ll need to add an “Authorization” header to your request. The body of the header will be the string literal “Token” followed by a space and then your token. An example header would look like:

Authorization: Token 3392fc6e-dbf7-465a-9291-2351b4eb6f18

Using curl, you would simply add a -H parameter like such:

curl -X GET “https://api.pearlcertification.com/1.0/homes/" -H “accept: application/json” -H “Authorization: Token 3392fc6e-dbf7-465a-9291-2351b4eb6f18”