Start To Develop THE NEXT LEVEL

Transcription

1 Start To Develop THE NEXT LEVEL

2 OVERVIEW I. MARKET & REGISTRATION II. API SUBSCRIPTION III. API TYPES IV. CALLING API S V. SANDBOX VS LIVE VI. TOOLS 10/13/2017 NxtPort The Next Level 2

3 I. MARKET & REGISTRATION 10/13/2017 NxtPort The Next Level 3

4 MARKETPLACE Available API s 10/13/2017 NxtPort The Next Level 4

5 MARKETPLACE - REGISTRATION Info available before registering 10/13/2017 NxtPort The Next Level 5

6 MARKETPLACE - REGISTRATION Simple registration proces 10/13/2017 NxtPort The Next Level 6

7 MARKETPLACE - REGISTRATION Register as a company or individual 10/13/2017 NxtPort The Next Level 7

8 II. API SUBSCRIPTION 10/13/2017 NxtPort The Next Level 8

9 API - SUBSCRIPTION 10/13/2017 NxtPort The Next Level 9

10 API - SUBSCRIPTION 10/13/2017 NxtPort The Next Level 10

11 III. API TYPES 10/13/2017 NxtPort The Next Level 11

12 ROLES USER Data Consumer - End user of the applications - Consumes data access - Registers and subscribes in marketplace - Identity used for data access - Logged and Billed APP Application (developer) - Builds the application - Integrates with the API s - Subscribes to the sandbox version - ISV or inhouse OWNER Data provider - Owns the data - Makes it available for others - Controls who has access 10/13/2017 NxtPort The Next Level 12

13 Direct Access UNLOCODE API STAY# API Port directory API Access controlled Consingment data API Track & Trace API VGM API Secure container release Only 1 data Provider General data Several data provider in control of data sharing OWNER OWNER USER = APP Data user and app provider often same company USER The data consumer takes the subscription, gets data shared Technically consumes the API 10/13/2017 NxtPort The Next Level 13 APP

14 API S DIRECT ACCESS APIM API key Data USER APP NxtPort Access management 10/13/2017 NxtPort The Next Level 14

15 USER Username Password API S ACCESS CONTROLLED API NxtPort Login NxtPort Access mgmnt Link user to entity Link entity to subscription Check App access allowed APIM ENTITY Sharing Check sharing for entity ClientID ClientSecret Data API key APP NxtPort OWNER 10/13/2017 NxtPort The Next Level 15

16 Direct Access Access controlled Access API key Access API key Access key (Oauth2 flow) Metering API key Metering Entity / User Usage ISV ISV Subscribe ISV Use API key in call Usage ISV ISV Register User User Subscribe User ISV fetch access token ISV Use API key & token in call 10/13/2017 NxtPort The Next Level 16

17 API S DIRECT ACCESS API S ACCESS CONTROLLED API S Description API s with public data No data sharing Registration of access for billing Data not publicly available Identification + Authorization needed Access API Key ( Data consumer) API Key ( application) Access token ( Data consumer + application) API key Subscribed entity sees API key in the marketplace ISV is given the API key (not shown in market place) Metering # calls per API Key # calls per API key or done by partners Subscription Done by Data Consumer Marketplace returns API Key Done by Data Consumer STS configured to provide access tokens 10/13/2017 NxtPort The Next Level 17

18 API S ACCESS DIRECT ACCESS API S ACCESS CONTROLLED API S NO OAUTH2 ACCESS CONTROLLED API S - OAUTH2 App/ISV Registration N/A ISV applies for access tokens (for a specific app + data consumer) Access tokens + API Key ISV registers his app Identity N/A N/A Full user login One time admin user login Service account / machine certificate Data access level On entity level Most applicable for entity level Depends on integration option -> entity or user level NxtPort N/A 1. Register App 2. Configure claims access 3. Generate access tokens 4. Provide API Keys 1. Register App 2. Configure claims access 3. Provide API Keys 10/13/2017 NxtPort The Next Level 18

19 III. CALLING API S 10/13/2017 NxtPort The Next Level 19

20 API CONSOLE 10/13/2017 NxtPort The Next Level 20

21 API CONSOLE 10/13/2017 NxtPort The Next Level 21

22 API CONSOLE 10/13/2017 NxtPort The Next Level 22

23 API CONSOLE 10/13/2017 NxtPort The Next Level 23

24 API CONSOLE 10/13/2017 NxtPort The Next Level 24

25 IV. SANDBOX VS LIVE 10/13/2017 NxtPort The Next Level 25

26 SANDBOX VS LIVE Sandbox - API s contain fixed data following a specific scenario - Independant from Live API s - Free Live - API s used for production data - Free until end of 2017 API works exactly the same in sandbox vs live for smooth transition to production 10/13/2017 NxtPort The Next Level 26

27 V. TOOLS 10/13/2017 NxtPort The Next Level 27

28 TOOLS Swagger.io - Api Interface Specification - Clear structure - Github - Documentation - Demo clients - Sample code /13/2017 NxtPort The Next Level 28

29 10/13/2017 NxtPort The Next Level 29

30 10/13/2017 NxtPort The Next Level 30

31

32 NXTPORT ARCHITECTURE : THE KEY ACTORS / ROLES API SOLUTION / APP PROVIDER (ISV) DATA OWNER/ PRODUCER DATA USER Data Sharing Rule Config 10/13/2017 NxtPort The Next Level 32