Introducing Service Layer API Terms and Documentation

Objective

After completing this lesson, you will be able to outline some basic terms used in the Service Layer API.

Terms Used in the Service Layer API

SAP Business One Service Layer is a REST API, allowing you to consume SAP Business One data.

The API follows OData standards and supports version 3.0 and version 4.0.

Before you interact with the Service Layer, it is important to learn about some basic terms commonly used in Service Layer API. In this video, you’ll learn more about these terms.

Note

The following demonstrations use the Postman tool to show the Service Layer API capabilities, but you can use any REST API tool to test the Service Layer API.

Service Layer Reference Documentation

The following links are additional resources that you can refer to as you work with the Service Layer API.

  • Service Layer API Reference | SAP Help Portal - This page contains a full list of resources names available in the Service Layer.
  • HTTP references - This document describes the overall architecture of HTTP, establishes common terminology, and defines aspects of the protocol that are shared by all versions.
  • OData Documentation - This link contains documentation related to OData 4.0 protocol.
  • DI API Reference | SAP Help Portal- This contains the API reference and data dictionary. You can find the explanation for each property. It also contains the SAP Business One table definition and the binding information for the corresponding property.

Summary

  • The Service Layer is a REST API that allows consumption of SAP Business One data following OData standards.

  • Key terms used in the Service Layer API include HTTP verb, URL, body, header, response, and status code.