Versions Compared

Key

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

...

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 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.

...

API Detailed Specifications

FinP2P Specifications repository on Github contains the detailed specifications for finp2p protocols, and the detailed specification for the Application APIs. The main goal of this repository is to provide accurate reference documentation for the aspects of finp2p that are independent of language or implementation.