API description

Description of how to use the Partner API

The Partner API is built as a REST API, following the industry-standard architectural principles for web APIs. By using a RESTful approach, the Partner API offers a simple and scalable solution for performing operations on resources. This makes it easy to understand and use, and allows for seamless integration with other systems and programming languages.

Partner API Request Base URL

https://psno-portal.svc.pasientsky.no/partner-api/

What is a REST API

A REST API (Representational State Transfer API) is a type of web API that uses HTTP requests to perform operations on resources. It follows a set of architectural principles, including statelessness, client-server architecture, and a uniform interface.

In a REST API, resources are represented by URIs (Uniform Resource Identifiers), and operations are performed on those resources using HTTP methods such as GET, POST, PUT, DELETE, and PATCH. These operations are typically used to retrieve, create, update, or delete resources.

A key feature of a REST API is that it uses a uniform interface, which means that the same HTTP methods and URI format are used for all resources. This makes it easy to understand and use the API, and allows for interoperability between different systems and programming languages.

Another important aspect of a REST API is that it is stateless, meaning that the server does not maintain any client-specific information between requests. Each request from the client contains all the information necessary to complete the request, including any authentication information.

Overall, a REST API is a popular choice for building web APIs due to its simplicity, scalability, and interoperability with different systems and programming languages.