How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth...

24
How to ... User Guide For TPP

Transcript of How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth...

Page 1: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

How to ...User Guide For TPP

Page 2: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Contents

1. The Developer Portal user interface ..............................................................................................................3 1.1. Home ........................................................................................................................................3 1.2. Getting Started .........................................................................................................................3 1.3. API Products ............................................................................................................................3 1.4. Apps .........................................................................................................................................3 1.5. Support .....................................................................................................................................3

2. Creating a new developer account ................................................................................................................4

3. Changing your password ..................................................................................................................................5

4. Change user settings .........................................................................................................................................6 4.1. Changing your account settings ...............................................................................................6 4.2. Changing your timezone setting ..............................................................................................7 4.3.Changingyourapplicationnotificationsettings.......................................................................8

5. Applications in the Developer Portal .............................................................................................................9 5.1. Registering an application ........................................................................................................9 5.2. Editing an application ............................................................................................................12 5.3. Deleting an application ..........................................................................................................13 5.4. Changing an application image ..............................................................................................13 5.5.Settingupnotificationsforanapplication.............................................................................14

6. APIs in the Developer Portal ..........................................................................................................................16 6.1. Browsing available APIs, code snippets, and example operations ........................................16 6.2. Selecting a Plan ......................................................................................................................17 6.3. Signing up to use an API ........................................................................................................19 6.4. Viewing application subscriptions .........................................................................................19 6.5.UnsubscribefromaPlan........................................................................................................20

7. Developer organizations in the Developer Portal .....................................................................................21 7.1.EditingthenameofaDeveloperorganization.......................................................................21 7.2. Adding users to a Developer organization .............................................................................22 7.3.RemovingauserfromaDeveloperorganization..................................................................23

page 2 of 24

Page 3: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

1. The Developer Portal user interface

Usethemenu itemsintheDeveloperPortaluser interfacetoregisterapplications,workwithAPIs, and obtain support.

ThefollowingsectionsdetailtheitemsinthemainmenuoftheDeveloperPortaluserinterface,andsummarizetheactivitiesthatyoucancompleteoneachoftheassociatedpages.

1.1. HomeTheHomelinksdirectlytotheAPIspage.

1.2. Getting StartedTheGettingStartedpagedescribesthetasksthatyoucompletetobeginworkingwithAPIsinthe Developer Portal.

1.3. API ProductsTheAPIProductspageshowsalltheAPIsthatareavailableforyoutoworkwith.ClickthenameofanAPItoseethedetailsofthatAPI,andtotestit.

1.4. AppsFrom the Apps page, you register new applications so that you can use the APIs that are avail-abletoyou.TheAppspageshowsalltheapplicationsthatyouhaveregistered.Clickthenameofanapplicationtoseethedetailsofthatapplication,andtomodifyit.

1.5. SupportFromtheSupportpage,youcanviewfrequentlyaskedquestions,andsubmitaquestionorfeed-backbyemail.

page 3 of 24

Page 4: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

2. Creating a new developer account

You can create new developer accounts in the Developer Portal.

Step 1: From the Developer Portal home page – developer.postbank.bg,clickCreate an account.

Step 3:ClickCreate new account.Step 2: Populate the available fields withthe details of the developer account youwant to create.• Name *

• Last Name *

• Company name• Username *

• E-mail *

• Password *

• Confirmpassword*• Terms & Conditions *

• CAPTCHA *

* mandatory field

page 4 of 24

Page 5: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 2:ClickPassword Step 3: Enter your current password, then enter your new password in the Pass-word and Confirm pass-wordfields.

Step 4:ClickSave

page 5 of 24

3. Changing your password

You can change your password in the Developer Portal password.

You need to login to view this content!

Step 1: From the Developer Portal home page, select My account.

Page 6: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

4. Change user settings

You can edit user settings in the Developer Portal, including timezone and account settings.

You need to login to view this content!

4.1. Changing your account settings

You can edit your Developer Portal account settings.

Step 1: Select My account in the Developer Portal home page.

Step 2: Select Account,andthenclickEdit.

Step 3:Fromthisviewyoucanchangemultiplefeaturesofyouraccount.

Step 4:ClickSave.

page 6 of 24

Page 7: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

4.2. Changing your timezone setting

You can change your timezone setting in the Developer Portal.

Step 1: Select My account in the Developer Portal home page.

Step 2: Select Account,andthenclickEdit.

Step 3:Youcanchangethetimezonefromthisview,undertheLocaleSettingstab.

Step 4:ClickSave.

page 7 of 24

Page 8: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

4.3. Changing your application notification settings

YoucanchangeyourapplicationnotificationsettingsintheDeveloperPortal.

Step 1:FromtheDeveloperPortalhomepage,clickApps.

Step 2: Select the target application.

Step 3:ClickNotification settings.

Step 4:Enablenotifications,andthenconfigurewhatyourequirenotificationfor.

Step 5:ClickSubmit.

page 8 of 24

Page 9: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

5. Applications in the Developer Portal

Youcanview,edit,configure,andcreateapplicationsintheDeveloperPortal.

5.1. Registering an application

BeforeyoucanuseanAPI,youmustregisteryourapplicationtotheDeveloperPortal!

WhenyouregisteranapplicationyouareprovidedwithaclientIDandclientsecretfortheap-plication.YoumustsupplytheclientIDwhenyoucallanAPIthatrequiresyoutoidentifyyourapplication by using a client ID and client Secret.

Step 1:ClickApps. The Apps page opens.

Step 2:ClickCreate new App.

Step 3:Completethedisplayedfields.

page 9 of 24

Page 10: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 4:ClickSubmit. Your application is displayed.

Step 5:Makeanoteofyourclientsecretbecauseitisonlydisplayedonce.YoumustsupplytheclientsecretwhenyoucallanAPIthatrequiresyoutoidentifyyourapplicationbyusingaClientID and Client Secret.

Step 6:Optional:TheclientIDishidden,todisplaytheclientIDforyourapplication,selecttheShow check boxforClientID.TheclientIDisdisplayedandcanbehiddenagainbyclearingthecheckbox

Step 7:Optional:Toaddanimage,clickUpdateunderthedefaultimage.Anewwindowopens;clickBrowse,selectanimagefromyourdirectory,andclickSubmit.

page 10 of 24

Page 11: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 8: Optional:TospecifyorchangetheURLthatauthenticatedOAuthflowsforthisapplica-tionshouldberedirectedto,clicktheEditiconandthenupdatetheOAuthRedirectURIfield.

Step 9: Optional: To change the application name or description, click the Edit icon.

Your application is registered!

page 11 of 24

Page 12: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

5.2. Editing an applicationYoucaneditapplicationsintheDeveloperPortal.Ifauserhasthecorrectpermissions,theycaneditthecontentofanyapplicationintheirorganization.

Step 1: FromtheDeveloperPortalhomepage,click Apps.

Step 2: Select the target application.

Step 3:ClickEdit.

Step 4:Makeanyrequiredchanges,thenclickSubmit

page 12 of 24

Page 13: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

5.3. Deleting an application

You can delete applications in the Developer Portal.

Step 1:FromtheDeveloperPortalhomepage,clickApps.Step 2:Selecttherequiredapplication.Step 3:ClickDelete.

5.4. Changing an application image

YoucanchangetheimageforanapplicationintheDeveloperPortal.

Step 1:FromtheDeveloperPortalhomepage,clickApps.

Step 2:Clicktheapplicationforwhichyouwanttochangetheimage,andclickUpdate.

Step 3:Browseforthetargetimage,thenclickSubmit.

YoucanremovetheimagebyclickingDelete.

page 13 of 24

Page 14: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

5.5. Setting up notifications for an application

YoucanenablenotificationsforapplicationssothatyouarealertedwhentheusageofanAPIisnearingitsratelimit.Ifyounoticethatanapplicationisreachingitsratelimit,youcantakeactionsuchaschangingthePlantoavoidimpactingtheusersofyourapplication.

YoucancontrolthefrequencyandmethodofreceivingnotificationsthatinformyouwhentheusageofanAPIisapproachingandexceedingtheratelimitsetonthePlanyouselected.

Youcanviewnotificationsfromthebuilt-inactivityfeedandbyemailwiththeoptiontoturnoffemailnotifications.

Ifyouhaveoneorbothofthefollowingconditions,thenyoucannotreceivenotifications:• TheAPIdeveloperdisabledtheactivitylogpolicyforanoperation.• Thenameoftheratelimitplanthatyouaresubscribingtoisnotoneofthenamesthatis

validforthenotificationstofunction.

Tosetupnotificationsforanapplication,completethefollowingsteps:

Step 1:ClickApps. The Apps page opens.

Step 2:Selecttheapplicationthatyouwanttoworkwith.

Step 3:ClicktheNotification settingstab.Thenotificationsettingspageisdisplayed.

Step 4: Select the Enable notifications for this application checkbox.

page 14 of 24

Page 15: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 5:Bydefaultyoualwaysreceivenotificationswhentheratelimitisexceeded.Ifyouwanttobenotifiedbeforetheratelimitisexceeded,selectoneofthefollowingoptions:• 50%oftheRatelimitisreached• 75%oftheRatelimitisreached• 90%oftheRatelimitisreached

Step 6:Selecthowfrequentlyyouwanttoreceiveanotificationfromoneofthefollowingop-tions. • Every minute• Every hour• Every day

Youonlyreceiveonenotificationperoperationperratelimitthresholdwithinyourchosentimeinterval.Forexample,ifyouchooseEveryhourandthe75%ratelimitisreachedtwice,youarenotifiedaboutitonlyonce.

Step 7:Afteryouenablenotifications,youalwaysreceivetheminthebuilt-inactivityfeed.Ifyoualsowanttoreceivenotificationsbyemail,selecttheEmailcheckbox.

The notification settings for your application are defined!

page 15 of 24

Page 16: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

6. APIs in the Developer Portal

6.1. Browsing available APIs, code snippets, and example operations

You can browse available APIs and their code snippets through the Developer Portal. CodesnippetsaresamplecodefragmentsthataregeneratedautomaticallyfromRESTAPIs.TheydemonstratehowanAPIconsumercaninvokeanduseanAPIoperation.

Step 1: FromtheDeveloperPortalhomescreen,clickAPI Products.

Step 2:Toseemoredetails,clicktheProductthatcontainstherequiredAPI,thenclicktheAPI.Youcanseethefollowinginformation:• Anyadditionaldocumentationavailableforyoutoread.• IfyouneedtoprovideaClientIDorClientSecrettoaccessthisAPI.• TheauthenticationrequirementsthatarerequiredtoaccesstheAPI.• The operations or WSDL operations that belong to the API.• The Plans that the operations belong to, including any pricing details.

Step 3:Toviewtheexamplecodeofanoperation:Clicktheoperation’stabtoexpandandshowitsdetails,includingcodeexamples.Youcanviewtheexamplecodeforyouroperationinseverallanguages:• cURL• Ruby• Python

page 16 of 24

Page 17: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

• PHP• Java• Node• Go• Swift• C• C#

6.2. Selecting a Plan

APlanisacollectionofRESTAPIoperationsandSOAPAPIWSDLoperations.IntheDeveloperPortal you can browse and select the most appropriate Plan to use with your application.

You must register an application to use with a Plan.

ToselectaPlan,completethefollowingsteps:

Step 1:IntheDeveloperPortal,clickAPI Products.

Step 2:ClicktheProductthatcontainsthePlanthatyouwanttoworkwith.

Step 3:InthePlansectionoftheProduct,clickthePlanontheleftthatyouwanttouse.ThedetailsoftheselectedPlanaredisplayed.

page 17 of 24

Page 18: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 6: Optional: To view the operations for the APIs that are included in the Plans to which the appli-cation is subscribed, click the name of the API.

Step 7: If the Plan is not restricted, you can use it immediately. If the Plan is restricted, the Plan is shown as Pending Approval, and you cannot use the requested Plan until the administrator approves your request.

You have selected a Plan!

Step 5: Select the application that you want tousewith thisPlan,andclickSubscribe. The application details are displayed.

Step 4: After you have identified the planthatyouwant touse,clickSubscribe.TheSubscribe dialog box is displayed.

page 18 of 24

Page 19: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

6.3. Signing up to use an API

You can sign up to use an API in the Developer Portal.

You must have registered an application in order to sign up to use an API.

Step 1:FromtheDeveloperPortalhomepage,clickAPIProducts.

Step 2:ClickthenameoftheAPIyouwanttoworkwith,andclickDetails.

Step 3:InthePlanssection,identifythePlanthatyouwanttoworkwithfromthelistofPlansavailableontheleft,thenclickSubscribe.

Step 4: Use the radio buttons to select the application with which you want to use this Plan, then clickSubscribe. You have signed up to use an API.

6.4. Viewing application subscriptions

You can view which APIs your application is subscribed to in the Developer Portal.

Step 1:FromtheDeveloperPortalhomepage,clickApps.

Step 2:Clickthenameofthetargetapplication.DetailsofthePlansandAPIssubscribedtobyyour application are displayed.

page 19 of 24

Page 20: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

6.5. Unsubscribe from a Plan

You need to login to view this content!

Step 1:FromtheDeveloperPortalhomepage,click Apps.

Step 2:Clickthenameofthetargetapplication.DetailsofthePlansandAPIssubscribedtobyyour application are displayed.

Step 3:TounsubscribefromaPlan,clickUnsubscribe alongside the Plan name.

page 20 of 24

Page 21: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

7. Developer organizations in the Developer Portal

Youcanadd,remove,andconfigureDeveloperorganizationsintheDeveloperPortal.

7.1. Editing the name of a Developer organization

YoucaneditthenameofyourDeveloperorganizationfromwithintheDeveloperPortal.

Step 1: OntheDeveloperPortalhomepage,clickMy organization.

Step 2: In the Managetab,clickEdit Organization.

Step 3:EnterthenewnameforyourDeveloperorganizationintheOrganizationnamefield,andthenclickSubmit.YouhavechangedthenameofyourDeveloperorganization.

page 21 of 24

Page 22: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

7.2. Adding users to a Developer organization

If theAPIproviderorganizationadministratorhasgrantedyoupermissiontocollaborate,youadd users to your Developer organization with the Users panel. Those users can then access the Developer Portal and use the APIs that have been made available to the Developer organization.

ToinviteuserstojoinyourDeveloperorganization,completethefollowingsteps.

TheUserspanelisonlyvisibleiftheAPIproviderorganizationadministratorhasgrantedyou permission to collaborate.

Step 1:OntheDeveloperPortalhomepage,clickMy organization.

Step 2:ClickAdd a user.

Step 3:Enterthee-mailaddressofthenewuserintheNew user’s e-mail addressfield.

page 22 of 24

Page 23: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

Step 4:UndertheRoleheading,usetheradiobuttonstoselectaroleforthenewuser,therolesare: • App Developer - Can create and edit applications and subscribe to Plans.• Viewer - Can only view applications and application activity.

Step 5:ClickInvite new user.

The user is added to the Developer organization, and they are sent an email with the subject line: “Welcome to developer_organization_name”.Theusermustclickthelinkthatisprovidedtoacti-vate their account and complete the setup.

7.3. Removing a user from a Developer organization

YoucanremoveadeveloperfromaDeveloperorganizationintheDeveloperPortal.

YoumustbetheownerofyourDeveloperorganizationandhavepreviouslyaddedthede-veloperyouwishtoremovefromtheorganization.

Step 1:OntheDeveloperPortalhomepage,clickMy organization.Step 2:ClickManage in the menu.Step 3:ClickRemove user fortheuseryouwanttoremove.

App Developer ViewerView and create applications View applications

View Products and APIs View Products and APIsView subscriptions and subscribe to

use APIsView subscriptions

Use the Developer Portal test tool Use the Developer Portal test tool

page 23 of 24

Page 24: How to - Postbank...tion should be redirected to, click the Edit icon and then update the OAuth Redirect URI field. Step 9: Optional: To change the application name or description,

oAuth test

oAuth test

Mastering OAuth 2 - Adobe Inc.€¦ · leveraging the OAuth 2.0 Authorization Framework Mastering OAuth 2.0 Charles Bihis Mastering OAuth 2.0 OAuth 2.0 is a powerful authorization

Mastering OAuth 2 - Adobe Inc.€¦ · leveraging the OAuth 2.0 Authorization Framework Mastering OAuth 2.0 Charles Bihis Mastering OAuth 2.0 OAuth 2.0 is a powerful authorization

Deutsche Postbank AG, Bonn Annual Financial Statements ... · Deutsche Postbank AG, Bonn Annual Financial Statements for the Period Ended December 31, 2008 and Management Report for

Deutsche Postbank AG, Bonn Annual Financial Statements ... · Deutsche Postbank AG, Bonn Annual Financial Statements for the Period Ended December 31, 2008 and Management Report for

Redirected Walking - Computer Science

Redirected Walking - Computer Science

H. Tschofenig OAuth 2.0 Security: OAuth Open Redirector · OAuth 2.0 Security: OAuth Open Redirector draft-bradley-oauth-open-redirector-02.txt Abstract This document gives additional

H. Tschofenig OAuth 2.0 Security: OAuth Open Redirector · OAuth 2.0 Security: OAuth Open Redirector draft-bradley-oauth-open-redirector-02.txt Abstract This document gives additional

19960116 Einde stages binnen Postbank

19960116 Einde stages binnen Postbank

OAuth for TeraGrid Gateways - …security.ncsa.illinois.edu/teragrid-oauth/OAuthforTGGateways...OAuth for TeraGrid Gateways Jim Basney Jeff Gaynor

OAuth for TeraGrid Gateways - …security.ncsa.illinois.edu/teragrid-oauth/OAuthforTGGateways...OAuth for TeraGrid Gateways Jim Basney Jeff Gaynor

Deutsche Postbank 2007 Group Annual Report Postbank ......I May 10, 2007 Annual General Meeting, Deutsche Postbank AG, with greater than 97 % adoption of agenda items; dividend unchanged

Deutsche Postbank 2007 Group Annual Report Postbank ......I May 10, 2007 Annual General Meeting, Deutsche Postbank AG, with greater than 97 % adoption of agenda items; dividend unchanged

OAuth 2 - Sesar Labsesar.di.unimi.it/corsi/SOASecurity/slide/OAuth2.0from...OAuth 2.0 From scratch What is OAuth 2 •OAuth 2 is an authorization framework that enables applications

OAuth 2 - Sesar Labsesar.di.unimi.it/corsi/SOASecurity/slide/OAuth2.0from...OAuth 2.0 From scratch What is OAuth 2 •OAuth 2 is an authorization framework that enables applications

DEUTSCHE POSTBANK AG, BONN ANNUAL FINANCIAL STATEMENTS … · DEUTSCHE POSTBANK AG, BONN ANNUAL FINANCIAL STATEMENTS (HGB) AS OF DECEMBER 31, 2015. DEUTSCHE POSTBANK AG, BONN ANNUAL

DEUTSCHE POSTBANK AG, BONN ANNUAL FINANCIAL STATEMENTS … · DEUTSCHE POSTBANK AG, BONN ANNUAL FINANCIAL STATEMENTS (HGB) AS OF DECEMBER 31, 2015. DEUTSCHE POSTBANK AG, BONN ANNUAL

POSTBANK March 2007

POSTBANK March 2007

Are Our Taxes Redirected to Education? - HakiElimuhakielimu.org/files/publications/Are Our taxes Redirected...Are Our Taxes Redirected to Education? Education Budget Analysis 2011/2012

Are Our Taxes Redirected to Education? - HakiElimuhakielimu.org/files/publications/Are Our taxes Redirected...Are Our Taxes Redirected to Education? Education Budget Analysis 2011/2012

Oauth Tutorial

Oauth Tutorial

OAuth Hacks A gentle introduction to OAuth 2 and Apache Oltu

OAuth Hacks A gentle introduction to OAuth 2 and Apache Oltu

The How of OAuth OAuth Hackathon – 4/26 @ Six Apart .

The How of OAuth OAuth Hackathon – 4/26 @ Six Apart .

Implementing OAuth

Implementing OAuth

Oracle Access Management OAuth Service€¦ · OAuth 2.0 authorization server and also offers several compelling differentiations to enable the OAuth 2.0 Client and the OAuth 2.0

Oracle Access Management OAuth Service€¦ · OAuth 2.0 authorization server and also offers several compelling differentiations to enable the OAuth 2.0 Client and the OAuth 2.0

Deutsche Postbank aG, bonn annual Financial statements ... · Deutsche Postbank a G, bonn AnnuAl FinAnciAl StAtementS For the Period ended december 31, 2013 And mAnAgement rePort

Deutsche Postbank aG, bonn annual Financial statements ... · Deutsche Postbank a G, bonn AnnuAl FinAnciAl StAtementS For the Period ended december 31, 2013 And mAnAgement rePort

DIVESTITURES: GROWTH REDIRECTED

DIVESTITURES: GROWTH REDIRECTED

Everything OAuth

Everything OAuth