On-board Producer API in PostNord API Gateway

Introduction

This guide contains the procedure and instructions to Onboard a Producer API for a project or developer into the PostNord API Gateway.


Step-by-Step

Pre-conditions

This section explains the what all needs to initiate Producer Api onboarding.

  • Your API should be deployed and ready to test
  • Decide upon the API classification, this will restrict the visibility of your API into Developer portal
    • public | private | internal

Register

  • Signed up to PostNord Sandbox Developer Portal with your PostNord email address by following below steps as one time activity
    • Go to PostNord AT Developer Portal and click Create Account
    • Fill-up the details with active PostNord email address, click Register and you will receive an email from PosNord to activate the account.
    • Check your given email box and activate the account with given link
    • Once you activated your account you will get Internal Plan and role, which lets you onboard the API

Swagger Quality Assurance

Follow PostNord API guidelines to design your API as per PostNord standards

Review the swagger against the PostNord Swagger template

  • An IAM secured API; must have a securityDefinitions defining the required scopes
  • Write good Descriptions associated with the endpoints
  • Used the defined HTTP status texts
  • Used the defined common PostNord fault object
  • Used predefined Information Objects
  • Verify the naming convention of objects/attributes
  • Verify Health check
  • QA meeting with the Team and present findings

Needs to be corrected until going into production


Publish New API

  • Login to PostNord AT Developer Portal
  • Go to API --> Producer APIs
  • Click on Publish New API
  • Once you click you will get two ways to Publish your API
  • If you have Swagger URL select Yes
    • Fill up the below form
    • You also have the option to Switch Manual Form
    • Provide your Swagger URL
    • Provide one or more backend request (non-harmful) & Health endpoint request, Preferable supply a Postman or Soap-UI project links.
    • Click Submit button
    • Once you Submit, we will review your details and contact you further if needed
  • If you don't have Swagger URL select No
    • Follow the below mentioned process
      • Add API Details
        • Provide your API Name
        • Provide short Description of your API
        • Provide one or more backend request (non-harmful) & Health endpoint request, Preferable supply a Postman or Soap-UI project links.
        • Select checkbox if your API needs IAM security
        • Choose classification of your API, which is as per consumer of your API
          • internal - If your API is only consumed by PostNord Internal Systems, Teams
          • private - If your API is consumed by PostNord partners
          • public - If your API is consumed by Outside world

          API Classification can be changed later based on audience

        • Select Search Tags, one of them in dropdown is mandatory and you can put as many more you want, which will help to ease your API Search into our portal
        • Click Next
      • Add PRODUCER API Details
        • Here you will see some of the fields already have the data, which we get you during signup. You can change this data if you want to.
        • You can add as many attributes you want with key;value pair which will be used for governance purpose e.g.
          • Key: HPSM Group -- ​Value: pn-api-gov
          • Key: Developer Name​ -- Value: Test
          • Key: Developer Email -- ​Value: abc.def@postnord.com
        • Click Next
      • Review API Details
      • Here you can review the details you have entered

      • If all looks good, please click Submit
    • Once you Submit, we will review your details and contact you further if needed