Skip to content

Attach Shared Resources to an API

When Onboarding Existing API, there might be a scenario where Organization will be using custom ssl certificates for their backend API. In such cases the API Manager should have the abiltity to support attaching of the ssl certificates to the backend implementation API before calling it.

Yappes Platform provides the ability to upload and manage cusomt-ssl-certificates as Shared Resources which is documented in the link Create/Update/Delete Shared Resource

Attach Shared Resources

  1. User can onboard the existing API as discussed in Onboard Existing API
  2. Under Manage, click on the My APIs tab
  3. Open any API of type Existing API
  4. Navigate to the Environments tab
  5. For the environment which you want to attach, click on the ssl icon, which opens the model panel with the details to attach ssl certificates
  6. Platform support Client Certificate Authentication type and two types of certificates can be attached
    1. PFX P12
    2. Cert Key CA

Attach PFX P12 Type Certificate

  1. Once the PFX P12 is selected, User will provided with the option to select pfx bundle which was uploaded as part of Create/Update/Delete Shared Resource
  2. After the selection, using Attach button custom-ssl-certificate will be linked to the specific environment of the API
  3. For each environment(production, testing and development) corresponding certificates can linked by following the above steps

Attach Cert Key CA Type Certificate

  1. Once the Cert Key CA is selected, User will provided with the option to select the cert, key and ca certs which was uploaded as part of Create/Update/Delete Shared Resource
  2. After the selection, using Attach button custom-ssl-certificate will be linked to the specific environment of the API
  3. For each environment(production, testing and development) corresponding certificates can linked by following the above steps

Detach/Update Certificate

User can to update/change the attached certrificates or detach the certificate completely from the API if needed.

  1. Navigate to the Existing API environment tab as described in Attach Shared Resources
  2. Click on the ssl icon of the environment for which you choose to update or detach
  3. If the certificates needs to be updated, then change the type and select the corresponding certificate as per the requirement and click Update button
  4. If the certificates needs to be delinked, then click Detach button, which unlinks the certificates from the APIs environment