You need to develop an application that calls one or more Smart APIs.
Here are the items that must be in place for you to get started:
-
Smart APIs are registered - The Smart APIs you want to call must be registered with the instance of Smart API Manager you plan to use for authentication and authorization.
Though installing, deploying, and configuring Smart APIs is an administrative task,
you need to confirm availability.
-
Select Smart APIs from the left panel in Smart API Manager to review the registered Smart APIs. If you do not see the Smart APIs you want to call, talk to an administrator.
-
Smart API ID (Resource) - You must know the resource ID for any Smart API that your Smart Client is going to call. The resource ID is displayed in Smart API Manager for each registered Smart API. The source code you will write to get an access token requires this ID.
-
-
Smart Client is registered - The software application you plan on developing must be registered as a Smart Client within the instance of Smart API Manager you are using.
There are many different types of applications you could be writing, such as a Windows
desktop application, a web client, or a mobile client. The type of application you
are developing will largely determine one important aspect of Smart Client registration,
which is selecting an authorization flow for your application. Do not worry if you
are uncertain which flow to select, as you can always change the flow for your client
later.
-
Smart Client ID and secret - When you register your Smart Client, you receive two important pieces of information: client ID and client secret. You always need the client ID—and possibly the client secret, depending on the authorization flow—to write authorization code to get an access token, which is required to call a Smart API.
-
Client ID is accessible via the Smart Clients feature in Smart API Manager. If you forget to save the password and need it later, you can reset its value from the Smart Clients feature area.
-
-
Smart APIs are accessible - You must ensure that the end users for your Smart Client have access to the relevant Smart APIs, that is, those APIs called by your Smart Client.
End users must have users and/or identities mapped to a group in Smart API Manager. That group must be authorized to access the relevant Smart APIs, that is, those APIs called by your Smart Client.
Smart API Manager controls access to Smart APIs at the group level. See Smart APIs and Groups for details on how to configure users and/or identities to access Smart API resources.
Once the above items are complete, and you have collected all the relevant information you need, you are ready to start writing code.