Documentation
-
Authentication
-
Data models
-
Tutorials
-
Release Notes
-
Sample cURL’s
Open API & JSON / HAL
Open API
-
Adheres to Open API Specification (OAS)
-
Language-agnostic interface to RESTful APIs
-
It can be use by documentation generation tools, code generation tools to generate servers and clients in various programming languages and testing tools
OpenAPI-Specification/3.0.2.md at main · OAI/OpenAPI-Specification (github.com)
JSON / HAL
-
JavaScript Object Notation
-
JSON is a lightweight format for storing and transporting data
-
JRNI API uses JSON payloads for the API requests and responses
-
HAL is Hypertext Application Language
-
HAL includes hyperlinks between API resources for easy self-discovery
API & Permission levels
| Public API | Member API | Admin API | Login API |
| No authentication** | Authentication is required | Authentication is required | Admin User Login |
| Does not allow users to update/change bookings | Your end consumers/customers log into your system. | Used to maintain your data in JRNI | Admin Single Sing On (SSO) |
| Used to obtain your booking availability on your various online channels | Allows your customers to check / update / cancel their bookings online | Designed for internal channels to make bookings on behalf of customers (call centres, in-store, counter services) | Member Login |
| Appointments can only be booked in available time slots. | Provides Elastic Search Reporting | Member Single Sign On (SSO) |
** All API requests require an App ID allocated by JRNI to use the API calls
Comments
0 comments
Article is closed for comments.