Connect a client or make a first call · FAQ
How do I make my first call to the Casafari REST API?
Get a credential and send it: Casafari clients log in to the Casafari REST API for a JWT; new users send an API key from the self-serve platform.
If you're a Casafari client: use your existing login.
- Send
POST https://api.casafari.com/loginwith youremailandpasswordas JSON (Login). - Send the returned
access_tokenasAuthorization: Bearer <access_token>to any operation your account covers.
The operations are described in REST API.
If you're new to Casafari: use an API key.
- Create a key (
cf_sk_…) in the console; it is shown once (creating a key). - Call
GET https://platform.casafari.com/v1/locations/search?query=Lisbonwith the key in theX-API-Keyheader, or asAuthorization: Bearer <api_key>. Place lookups cost 0 units, so this first call is free.
Never put the key in a URL. For other products and operations, see the base URL and the OpenAPI specs.