!"#$%&'"()!&*+,'#-).!/)*0() 1."+2. Kevin Glinski Lead Developer Evangelist

Transcription

1

2 !"#$%&'"()!&*+,'#-).!/)*0() 1."+2 Kevin Glinski Lead Developer Evangelist

3 PureCloud Platform API REST Based API OAuth2 Authentication API First Design

4 Anatomy of an API URI 4ae6f7d1c974 URL Base Version Resource

5 Different Regions Different Hosts Region Application API Americas apps.mypurecloud.com api.mypurecloud.com Japan apps.mypurecloud.jp api.mypurecloud.jp Australia apps.mypurecloud.com.au api.mypurecloud.com.au Europe West apps.mypurecloud.ie api.mypurecloud.ie Europe Central apps.mypurecloud.de api.mypurecloud.de

6 Rate Limiting X number of requests in Y time Return HTTP 429 if over limit HTTP response headers indicate thresholds Response Header Description Example inin-ratelimit-allowed inin-ratelimit-count inin-ratelimit-reset The maximum number of requests allowed before rate limiting is enforced The current number of requests currently counting towards rate limiting The number of seconds remaining until ininratelimit-count is reset

7 Real-time Notifications Web socket notifications Real-time updates when things in PureCloud change Eliminates the need for polling

8 ININ-Correlation-Id Header Id given to a specific API request Used for troubleshooting

9 SDKs

10 SDKs

11

12 OAuth The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf.

13 OAuth (in English)? Authorization method that lets users grant applications access to their data

14

15

16 Why OAuth? Each party involved can limit access to an application at any time Users can must grant applications to their data and can later revoke access Service Providers can block applications that are violating TOS or appear to have been compromised Applications can refuse to act on behalf of a user Users never give their password to 3 rd party applications An application must define what data it is going to access

17 OAuth Players End User (resource owner)! Grants and Rejects access for an application to access their PureCloud data! Owns the data in PureCloud Application (consumer)! Accesses the data granted to it by the End User! Connects to the service provider on behalf of the user PureCloud (service provider)! Hosts the resources

18 OAuth Grant Types Implicit Grant Authorization Code Grant Client Credentials Grant OAuth2 SAML2 Bearer

19 OAuth Grant Types Implicit Grant Single step auth process Ideal for client-side applications Easier to setup, less secure than Authorization Code Grant

20 OAuth Grant Types Authorization Code Grant Ideal for Client/Server applications More secure than Implicit Grant

21 OAuth Grant Types Client Credentials Grant Ideal for back end services Does not operate in the context of a user Does not require a UI to log in Granted a PureCloud role to operate under Specific for the org they were created in

22 OAuth Grant Types OAuth2 SAML2 Bearer Acts as a bridge between a SAML2 identity provider and the PureCloud authorization server

23 Grant Type Use Cases I want to: Do anything with conversations e.g. call control Grant Type: Implicit, Authorization Code, SAML

24 Grant Type Use Cases I want to: Create a script that syncs users and downloads analytics data without any user intervention Grant Type: Client Credentials

25 Grant Type Use Cases I want to: Create a web app and control who can use it Grant Type: Authorization Code, SAML

26 Grant Type Use Cases I want to: Create a C# desktop app Grant Type: Implicit Grant

27 Got My Auth Token, Now What?

28 OAuth Scopes (On Roadmap) Define what PureCloud resources an app has access to Yes it is on the roadmap, no I won t commit to to a date

29

30 TREAT YOUR CLIENT CREDENTIALS GRANT CLIENT ID AND SECRET AS IF THEY WERE YOUR PASSWORD!

31 Use Client Libraries! Use a client library to help you out! JS Library (browser)! JS Library (node)

32 Cache Auth tokens Cache/Reuse Auth tokens until expiration Implicit #access_token=my-token&expires_in=seconds-until-expiration&token_type=bearer Authorization Code and Client Credentials { } "access_token": "my-authentication-token", "token_type": "bearer", "expires_in": seconds-until-expiration, "error": "

33 Resources Documentation Developer Tools Forum