WebAPI

Definition

With an Application Programming Interface, software applications can communicate and interact with each other. In most cases, such an interface is a Web application. An API enables the automated retrieval of data. The own application is allowed to use parts of the other application via the programming interface. More precisely defined, an API includes a series of protocols, routines and tools that can be used to access software functions.

In addition to accessing databases or hardware such as hard disks or graphics cards, a programming interface can also be used to create or simplify components of the graphical user interface.

The automation of work processes saves resources in the form of time. In addition, an API is made available at a central location, but used decentrally, which saves the detour via the hardware.

API use

External APIs: The APIs provide services and functionality that enterprises can integrate with their local operating system.

Internal APIs: It describes the exchange within a system.

Authentication APIs: Used to authenticate certain users.

Authorization APIs Represents the interfaces for permitting access.

API types

Function-oriented programming interfaces

Function-oriented programming interfaces know only functions with or without return value as means of communication. The concept of handles is almost always used. You call a function and get a handle back. This handle can be used to call further functions until the handle has to be closed again.

File-oriented programming interfaces

File-oriented programming interfaces are addressed via the normal file system calls open, read, write and close. If data are to be sent to an object, they are written with write, if data are to be received, they are read with read.

Object-oriented programming interfaces

Object-oriented programming interfaces use interface pointers and are therefore much more flexible than function-oriented programming interfaces. A type library is often included.

Protocol-oriented programming interfaces

Protocol-oriented programming interfaces are independent of the operating system and hardware. However, the protocol must always be reimplemented. In order to minimize this effort, the protocol-oriented interface is encapsulated by a function- or interface-oriented interface. A further distinction can be made here between general (e.g. SOAP) and application-specific (e.g. SMTP) protocols.

[Sources: Wikipedia, seo-trainee.de]

Content

With the REST Representational State Transfer is a programming paradigm for distributed systems, especially for web services. The main purpose of REST is machine-to-machine communication. REST is a simple alternative to similar methods like SOAP and WSDL and the related method RPC. The term "Representational State Transfer" is used to describe the transition from the current state to the next state of an application. This state transition takes place by transferring the data representing the next state. [Wikipedia] based 446 Plattform^® WebAPI (short: 446 WebAPI) the exchange of data can be carried out, the authentication of users can be carried out and the interfaces for the access permission can be defined.

On the 446 Plattform^® under Settings | Administration | Apps, access to the various applications can be managed.

The Reference section shows the functions that you can use to read, update, and create 446 Plattform^® objects. Under Use the creation of a ticket and of an expense using 446 Plattform^® WebAPI and Postman software (software solution for API development) is explained. An example of the integration of the 446 WebAPI into a custom solution is discussed in the Example application section. Special conditions for Search requests for tickets are discussed in the fourth section.

Chapters:

Reference

Use

Example application

Search requests