API Resources

Joint API Data Dictionary

This is the API Data Dictionary (“Dictionary”), jointly owned by the IFSF (www.ifsf.org) and Conexxus (www.conexxus.org), and shared in order to assist in the use of our international standards.  V1.0 of the dictionary is open to the public and everybody is allowed to use it.  Future versions may be made available to the public as well.  We expect many users will find the Dictionary helpful to understand retail fueling and convenience and to define further innovative and collaborative APIs.

API Development Roadmap

View the Conexxus/Open Retailing development roadmap for APIs.

API Design Rules for JSON 

This document describes the Open Retailing (fuel retailing and convenience store) style guidelines for the use of JSON based APIs, including property and object naming conventions. These guidelines are based on best practice gleaned from IFSF, Conexxus, OMG (IXRetail), W3C, Amazon, Open API Standard and other industry bodies.

API Implementation Guide - Security 

This document describes the Fuel Retailing and Convenience Store API implementation guidelines for security.

API Implementation Guide - Transport Alternatives

This document describes the Fuel Retailing and Convenience Store transport layer alternatives for RESTful web services carrying JSON based APIs.

Design Rules for APIs OAS 3.0 

This document describes the Open Retailing (fuel retailing and convenience store) style guidelines for the use of RESTful Web Service APIs, specifically the use of the OAS3.0 file format and referencing of relevant JSON Schemas from that file. These guidelines are based on best practice gleaned from OMG (IXRetail), W3C, Amazon, Open API Standard and other industry bodies.

These guidelines are not to be considered a primer for how to create APIs.  There are thousands of documents and blog posts about APIs and best-practices for creating them.  This guide is rather a set of practices to serve as “guardrails” to ensure that Open Retailing APIs have a consistent design

API Webinars 

Each month Conexxus hosts complimentary public webinars on a variety of topics, including webinars on APIs.  Please visit our Webinar Library to view recordings and upcoming webinars, which can be filtered by topic.

FAQs

For Frequently Asked Questions about the Conexxus or Open Retailing repositories, please visit:   https://openretailing.org/faqs.html  Here you will find questions and answers on APIs, Git, GitLab, setting up SourceTree, generating SSH keys, the API Data Dictionary, available tools, simulators, and much more.