Understanding the basics

Before we dive deeper into the more advanced application types and configurations, it's worth taking the time to better understand the basics of vcita's applications.

When creating applications, you'll constantly come across several terms, so it's better we understand them now and get them off the way.

Integration points

An integration point refers to the place in the UI that your app integrates with.
For example, if you create an app that creates a new sub-menu item, the integration point of your app is the menu.

App assignment

Important: applications that have an integration point in the UI must be assigned to the relevant accounts, or directory, in order to appear in the UI.

Why?
Applications are essentially abstract entities that have the ability to make API calls on behalf of specific accounts.
However, if an app needs to have a UI appearance (like an app that adds a menu item) - this app needs to be assigned to the requested account.

For assigning your apps please contact vcita directly and we'll be happy to assist.

Application name

As it sounds, this is the name of your application.
Applications that have an integration point in the UI will use the application name to present themselves.
For instance, if you create a payment gateway application, the name of the payment gateway in the payments settings page will be the app name.

Redirect URI

The redirect URI relates to the OAuth2 protocol which requires you to specify a redirect URI that users will get redirected to after the authorization is approved.
Since OAuth is a major part of any application, it is a mandatory field for creating new applications with vcita.

Trusted Apps

Trusted apps will not require users' permission during the OAuth flow, while non-trusted apps will require users' grant, by opening a window asking the user to allow the app access to their vcita account.

Country whitelist

Applications can specify a list of countries that can load the app, based on the country name specified at the account level.
This can be a very useful solution if you want your app to only be available in certain countries, due to regulation differences, etc.

Applications that have no supported_countries list specified, will be available to all geo-locations.

client_id and client_secret

Both of these parameters are returned in the response body of your "create app" request.
It's highly important to store these in your database as they can't be retrieved again at a later time.

You'll need to use the client id and client secret during the OAuth process.

app_code_name

The app_code_name is also returned in the body response when creating an app.
It is used as the app identifier (even though there's an app id param as well).
The app_code_name is used as your app identifier in all application-related APIs.


Did this page help you?