Getting started with the API

If you’re looking to automate common tasks like create bookings from third party services that extend Yardman, our API is to help you make it done.

RESTful JSON API

Following the best practices and standards our API do its best to adhere to the principles of RESTful methodology. Manipulating resources is done over the HTTP protocol. According to these principles all sent and/or requested data is done via proper HTTP method like GET, POST, PUT or DELETE in JSON format.

Data exchange security

Communication between Yardman API is secured by valid SSL certificate so it is safe to communicate with it over public and non-secure networks.

Each API request requires authorization to get or modify any kind of data (whenever using GET, POST, PUT, or DELETE). It is made by using well known, token-based authentication with JWT (JSON Web Tokens). In a nutshell JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.