How to Use The Semantic API Portal

The BIAN Semantic API Portal can be accessed  here: https://bian.org/semantic-apis/

1.  Landing Page

   Each row of text below represents a BIAN Service Domain.

 

• •  Individual Service Domain Page

 

• Below is a look into each of the points above, in more detail

  • • API Console

      • Highlights
        • • For each Service Domain, API Endpoints are now grouped by the Control Record and Behaviour Qualifiers, to align with the functional aspects of the Service Domain
            
          • Endpoints reflect Service Domain and Behaviour Qualifier specific names and IDs, replacing the generic terms used in previous versions. They also include the Action Term in the path
          • API Endpoint payloads now mirror exactly, the Service Operation Input / Output parameters as specified in BiZZdesign
          • View previous versions

        

      • Download
        • • Client SDKs and Server Stubs in various programming languages including java, .Net, Go, Dart and so on
          • Documentation
          • API in JSON and YAML

        

  • • • Try It
        • • Execute – To get a response with ‘sample’ data
          • View the ‘Curl’ and the ‘Request URL’ to call the API (with sample data)

        

  • Executive Summary

    – this is an executive summary for this Service Domain.

• Examples of Use

  – this is a list of one or more examples where this Service Domain is in use.

• Role Definition

  – this defines the role of this Service Domain.

• Related Business Scenarios

  – these are links to example business scenarios (use cases or business processes), where this Service Domain participates. Clicking the link opens a new page with the relevant. Business Scenario. Clicking the ‘Back’ buttons, brings you back to this page

• Core Business Object

  – this is a link to the Core Business Object related to this Service Domain. Clicking the link opens a new page with the relevant. Business Scenario. Clicking the ‘Back’ buttons, brings you back to this page.

• Key Features

  – this is a list of key features of this Service Domain.

• From Business Scenarios to API Endpoints

  Below is an example of how to navigate from a Business Scenario Diagram (as found in the Service Landscape) to an API endpoint:
  

• From Service Domain Control record Diagrams to APIs

  Below is an example of how to navigate from a Service Domain Control Record Diagram (as found in the Service Landscape) to an API endpoint: