Rest API

The Zirius Pluss API provides a set of RESTful endpoints that allow you to interact with various functionalities of the Zirius Pluss platform. To access these endpoints, you'll need to include your Access Token in the Authorization header of your HTTP requests.

API Specification:

You can obtain the YAML file containing the API specification using the following link:

110KB

api-docs.yaml

Open

Alternatively, you may contact the Zirius support team for assistance in obtaining the API specification.

Using Endpoints:

Once you have the API specification, you can use it as a reference to interact with the available endpoints. Here's an example of how to make a request to an endpoint using cURL, with the Access Token and company ID included in the request headers:

bashCopy codecurl -X GET \
  https://api.zirius.no/endpoint \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace YOUR_ACCESS_TOKEN with your actual Access Token obtained through the authentication process. This example demonstrates a GET request to an endpoint, but you can adapt it for other HTTP methods (POST, PUT, DELETE) and endpoints as needed.

Endpoint Documentation:

For detailed information on each endpoint, including its parameters, response format, and usage examples, refer to the API documentation created using the OpenAPI Specification. The documentation provides comprehensive guidance on the usage of each endpoint, ensuring that you can effectively leverage the functionality offered by the Zirius API.

You can view the API documentation, which is created using the OpenAPI Specification.

Note:

Ensure that you securely handle and protect your Access Token, as it serves as the key for accessing the Zirius API endpoints.

By following these guidelines, you can effectively use the REST endpoints provided by the Zirius Pluss API to interact with the Zirius Pluss platform and integrate its functionalities into your applications and systems.