Skip to content

API Versions

Add new API version

  • Select major, minor, and patch of the API Version.

Sandbox dependencies

  • Search npm packages and add them to the list of sandbox dependencies.
  • You can choose the version of the npm package.
  • Once the package is added user can use that package in the API code.

Secret keys

  • Add secret key-value pairs here.
  • When the API Maker user installs that third party API the user can add the secret keys in them secret.
  • The API Maker user needs to select the bundle and API version. Then the keys are added in them secret.
  • If the secret key is 'Is required' then the API Maker user must have to have provided that key in the secret.

API version documentation

  • Add documentation if you want to write for your reference in the future.
  • The can have details description how the API version will work.
  • So, it will easy for the API Maker users to understand the Third party APIs.

API version state

  • When the user creates a new API version it has a DRAFT state.
  • PENDING_APPROVAL the approval from the store root user is pending.
  • Once the store root user approves the API version it has a PUBLISHED state. In this state API version, the owner can not delete APIs.
  • DEPRECATED state for those which API Maker has not recommended installing yet the user can if they want.
  • If the API version has a BLOCKED state it means the user can not find that API in the API Maker store.

Utility class

  • Basically Utility class is the code that the users can import into any APIs and use when required.
  • The user needs to give the name and path of the utility class.
  • Here, you can see how to import the utility class.
import * as utilityClassXyz from 'utils/utilityClassXyz';