Ana içeriğe geç

Approval Requests

API Product Access Settings​

Users do not directly access APIs; they first create an application and request access to the API product through this application.

Whether an application's subscription to an API product requires approval is decided at the plan level, not the product level. The user selects a single plan when subscribing, and that plan's Approval Type applies:

  • Automatic (shown with the Auto approval badge): The subscription is approved immediately and the user gains access. This is the default approval type for plans.
  • Manual (shown with the Approval Required badge): The subscription is created in the Waiting status and waits for the product owner's approval on the Approval Requests screen (described below).

The approval type is set separately for each plan on the API product's Plans tab; for details, see the API Product page. Automatic and manual approval plans can coexist in the same product.

Info

The target plan's approval type also applies when the plan of an existing subscription is changed: if the target plan is Automatic, the change is applied immediately; if it is Manual, the change waits for approval and the old plan keeps working until it is approved.

Note

The product-level "Access requests from applications" setting from older versions has been deprecated; the approval decision is made only by the plan's approval type.

Usage in Portal Interface​

After a plan's Approval Type is saved as Manual, it can be tested from Portal as follows.

On the API Portal Screen, APIs are selected and the relevant product is opened, and the following operations are applied.

API Product Application Registrations Screen

Application addition request is made.

API Product Application Registrations Screen

Application name and information are created or edited as in the example image.

API Product Application Registrations Screen

After App is entered, applications and plans are viewed by clicking the save button.

API Product Application Registrations Screen

Registration is made by selecting the relevant application and relevant plan.

Info

To set plans and their approval types, see the Plans tab on the API Product page. For visibility settings, see the Visibility section on the same page.

The operations to be performed are explained in order below.

Access API Portal Page and Product Selection

The user who wants to use the API enters the Portal > APIs page. On this page, API products grouped by categories (Education, Store, Entertainment, etc.) are listed. The user selects the API product they want to use and clicks the "Explore API" button.

API Product Detail Page and Application Creation

On the API product detail page, click on the "Applications" tab. If there is no registered application, the message "You have no registered application for this API product" appears.

Click the "Create New App" button and in the opened pop-up:

  • Enter application name and description
  • Create the application by clicking the "Save" button
Registration

In the "Select an application and plan to register" popup:

  • Select the application they created
  • Select a plan (e.g., Plus)
  • Click the "Register" button
Viewing Registration Status

Registration status is displayed in the "Applications" tab:

  • Pending approval: Waiting for product owner's approval
  • Approved: API is ready to use
  • Rejected: Access request was rejected
Info

When an access request is created by a user, this request is forwarded to the Apinizer API Manager > Administration > Portal > Approval Requests page on the Apinizer interface. On this page, product owners can view, review, and perform approval or rejection operations on access requests sent to them if they deem appropriate. This page is explained in detail below.

Tabs of the Approval Requests Screen​

The Approval Requests screen consists of the following tabs:

TabContent
API Product App RegisterSubscription requests to plans with manual approval. Described below.
Account/DeveloperApproval requests of accounts that sign up to the Portal while automatic account approval is off. Described below.
Account Organization RegisterApproval requests of sign-ups that entered organization information during Portal registration. In the window opened with Review, the registration details are shown; when approving, you choose whether the account is added by creating a new organization or by attaching it to an existing organization. When rejecting, an optional message can be sent to the applicant.
Promotion RequestsVisible only if promotion is enabled in the active portal's settings. Requests of sandbox applications to move to production are listed; with Review, the request summary and uploaded documents are viewed and the request is approved or rejected with a reason. For details, see the Application Promote page.

Approval Requests API Product Application Registration​

When the Approval Type of the selected plan is Manual, users' registration requests are listed on the Apinizer API Manager > Administration > Portal > Approval Requests Page.

API Product Application Registrations Screen
FieldDescription
API Product
(API Product)
Which API product access is requested for
Account/Developer
(Account/Developer)
Email address and name of the user making the request
Organization
(Organization)
Organization to which the user belongs
Application
(Application)
Which application the registration was made with
Plan
(Plan)
Selected subscription plan and details
Status
(Status)
Status of the request (Waiting, Approved, Rejected)
API Product Application Registrations Screen
Selecting Pending Request

Click the "Waiting" (Bekliyor) button in the Status column

Viewing Request Details

"Confirm the operation" popup opens and request details are displayed:

  • Account/Developer Information: User information (email, name, organization, phone)
  • API Product Information: API product name and title
  • Plan Information: Application name and selected plan and details
Making Decision

Admin evaluates the request and makes a decision:

  • Approve: Approves the request, user gains access to the API — together with every other currently approved subscription of the same application, this is what writes the application's access rows on the ACL, also for an application with no credential; see Access of an Application. If the selected plan carries a Limit Profile reference and the same application already has an active binding from that plan family through another subscription, the approval dialog surfaces this as a warning; the existing binding is kept, and switching to this plan's profile instead is a separate, explicit choice with Switch the Profile.
  • Reject: Rejects the request, user cannot gain access.
Info

In both cases, an automatic notification email is sent to the user.

Application gets an API Client on first approval

If the application behind the request has no credential at all yet, approving its first registration issues it an API Client. The client's secret is not shown here — the application owner obtains it by rotating the client's secret from the Portal application detail page or the Manager API Client detail screen. Approving a second registration for the same application reuses its existing client or credential; it never issues a second one. Applications that already carry a legacy credential are unaffected and keep using it.

Automatic Approval Setting​

API Portal is configured as automatic approval by default. To manage this process, the following steps are applied.

The approval process for users who want to become new members of the Portal is controlled by the "Auto Approve Account/Developers" setting in Apinizer API Manager > Administration > Portal > Settings > Portal > Security tab.

If this setting is on, the account can be logged in directly with email verification without admin verification.

If this setting is off, the email address is first verified, then the registration request comes to the Apinizer API Manager > Administration > Approval Requests > Account/Developer screen.

API Product Application Registrations Screen
FieldDescription / Operation
Auto Approve Account/Developers
(Auto Approve Account/Developers)
Setting Off (Not Active):
User fills out registration form.
System sends verification email to user.
User completes email verification.
Registration request is listed in Apinizer API Manager > Administration > Approval Requests > Account/Developer tab.
Admin manually approves or rejects the request.
Auto Approve Account/Developers
(Auto Approve Account/Developers)
Setting On (Active):
User fills out registration form.
After email verification, account is automatically approved.
User can immediately log into Portal.
Admin approval is not needed.
Request does not appear in Apinizer API Manager > Administration > Approval Requests > Account/Developer tab. Automatically approved.

Approval Requests Account/Developer​

When automatic approval is off, admin views pending registration requests in the Apinizer API Manager > Administration > Approval Requests > Account/Developer tab. The following information is listed for each request:

API Product Application Registrations Screen
FieldDescription / Operation
Email
(Email)
Email address of the user who is a member of the Portal is displayed.
Full Name
(Full Name)
Name and surname of the user who is a member of the Portal is displayed.
Organization
(Organization)
Organization to which the user who is a member of the Portal belongs is displayed.
Phone Number
(Phone)
Phone number of the user who is a member of the Portal is displayed.
Approval Status
(status)
After the user verifies their email address, the "Account Approval Required" section becomes enabled. Then one of the "Approved" or "Rejected" statuses is selected.
(Confirmation Needed, Approved, Rejected)

Admin clicks the Status button to approve or reject the user registration after the user verifies their email address.

Info

In both cases, an automatic notification email is sent to the user.

You can review the Email Templates link to customize automatic notification emails.