Versions Compared

Old Version 11

changes.mady.by.user Ami Ben-David

Saved on

compared with

New Version 12

changes.mady.by.user Ami Ben-David

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Having a standard specification of this layer allows for an open ecosystem of applications and services for financial institutions to choose from and work with.

Application API Main Functionality

An application integrates with the API to:

...

The Application API abstract and hides from the application developer all the implementation complexities described above. And, in conjunction with the FinP2P network protocol, it abstracts the topology of the network by routing local and remote requests transparently.

Data model

For more on the data model utilized by the Application API please check the FinP2P Data Model

API Protocol Specifications

The Application API is specified in the OpenAPI 3.0 format. Requests and responses can be crafted with auto-generated code using Swagger Codegen or OpenAPI Generator, are human-readable (easy to debug and understand), and can be used in servers and browsers.

The transactional API conforms to REST. It has predictable, resource-oriented URLs, and it uses HTTP response codes to indicate API errors. JSON is returned by all API responses, including errors

The The query API conform to GraphQL, as such it offers significantly more flexibility for the application development. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST. GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify.

The GraphQL data query language is a specification. It determines the validity of the schema on the API server. The schema determines the validity of client calls. The schema defines an API's type system and all object relationships.
An application layer-GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

API Detailed Specifications

Draft to be release shortly.