Skip to main content

APIM Public documentation

Description​

Trustnest APIM is a service of Trustnest.

TrustNest has launched an APIM to provide a single place to list and access to Trustnest internal APIs (limited only to REST - for now). A developer portal is available online at https://trustnest.developer.azure-api.net/

Following the same principle as postIT, Trustnest APIM is exposed over internet, authenticates users with MFA, and provide API to answer common request such as (in the vision): grant an API permission to a given service principal, send an email, ask for service principal, get a cloud consumption usage data. When an API is not related to Trustnest itself, the API is regrouped in a "Beta Product" (APIM meaning).

img

Few definition & meaning:

  • The Developer Portal in Azure API Management (APIM) is a self-service web portal where API consumers can discover, explore, and subscribe to APIs using postIT. It provides comprehensive documentation, interactive API testing, and access to API keys and other credentials. This portal enhances collaboration between API providers and consumers, streamlining the development and integration process while fostering a community around the APIs.
  • The Gateway in Azure API Management (APIM) is a high-performance, scalable component that acts as an intermediary between API consumers and backend services. It handles tasks such as request routing, protocol translation, rate limiting, throttling, authentication, authorization, and caching. The Gateway ensures secure, reliable, and consistent access to APIs, enforcing policies and providing analytics to monitor API usage and performance.

MCS Chatbot​

caution

The MCS chatbot is a helpful tool for quickly finding information in our documentations. However, since it uses generative AI, the information it provides may not always be 100% accurate and should be double-checked with the official documentation.

apim keyword

By including the 'apim' keyword in your query, you'll only search through the apim public documentation !

Did you try our chatbot at the bottom-right corner of the screen ? ↘

Hi!

Use cases​

  • Automatize the provisioning of your trustnest environment
  • Consume Azure OpenAI API and test new models
  • Automatize the communication with your consumer

Getting Started​

tip

APIM provides several fake APIs to facilitate your onboarding:

  • Echo API which is an API that converts your JSON body in XML, without any authentication, just for testing !
  • Echo API innovate is an API that do the same thing than Echo API, but it requires to first be registered in the APIM Innovate APIM Product and second get an oauth2 token.

So first, open a browser and access to https://trustnest.developer.azure-api.net . Now you should see this:

img

Second, you can try the Echo API using Tutorial: Run my first call to TDP APIM using Echo API

tip

Echo API is an API that does not require any authentication or subscription key

Next steps:

  • subscribe to APIM Products: Innovate (to get access to Echo API Innovate, for instance to test a secured call to APIM) or Industrialize (to get access to API to send emails, create Service Principal or Grant permissions to Service Principals). How ? just following this postIT link: Subscribe to Trustnest APIM

APIM Products​

APIM Beta Products​

Trustnest Core AI API (ex: genAI) Section​

note

You are interested in Artificial Intelligence services of TDP ? Have look to Artificial Intelligence Core Services - in Trustnest Portal

Consume OpenAI API using APIM Developer portal:

If you want to consume API without the APIM Developer Portal, few tutorials are available:

APIM Innovate Products​

doc on echo API innovate coming soon... link: https://trustnest.developer.azure-api.net/api-details#api=644833a12e47ff426dae7de3&operation=644833a9a3c1003e935891fe

APIM Industrialize Products​

doc on MCS Landing Zone/IAM - Public APIs coming soon... link: https://trustnest.developer.azure-api.net/api-details#api=mcs-landing-zone-iam-public-apis&operation=post-mails

API Producer & HOWTO section​

Known limitations​

  • Trustnest APIM supports only REST API for now.

TROUBLESHOOTING​

DEPRECATION​