# Overview

The provided API leverages REST over HTTP. In order to communicate to the api you can use any client compatible with these protocols. So the api consumes and produces JSON documents unless specified otherwise in the OpenAPI reference document. Our API uses predictables resource paths, standard http verbs and response codes.

This is the base url for the api. And it's also where you can view and test the endpoints using the Swagger UI.

https://api.sofy.fr/v1

So all requests urls will have the following format, where you replace <resource> with the name of the resource you want to interact with.

	https://api.sofy.fr/v1/<resource>

In order to access the api endpoints you must authenticate. Learn more about it in the next step