User guide
Document name: USER GUIDE
| Document version | 1.1 |
|---|---|
| Document owner | Nikola Stojanovic |
| Release date | 06.04.2022 |
Registration
To get full access to the test environment and obtain the test credentials and dedicated test data user of the developer portal must go through the following process:
Login with a domain account (LDAP login)
Creating a user account to access the system
Log in with a domain account (LDAP login)
In username field enter your domain account in specified format
[username]@asseco-see.[countrycode]
[username]@ [countrycode].asseco-see.local
For example aca@asseco-see.rs, bogdan@mk.asseco-see.local
In domain password field enter your domain password.
After successful login, you will be redirected to the dashboard screen with a list of APIs for domain organization.
Log in with a local account
The registration process goes through the following steps:
To start the process visitors must click on the Register button in the main menu. As a first step of the process, the registration form is presented to enter user information.
Figure 1. User registration form - developer portal user
New users must fill in the following fields:
First name
Required, the first name of the user
Last name
Required, last name of the user
Email address
A required, unique and valid email address will be used as a username to access the system
Company name
Optional, Name of the company the user is working for
Password
Required, masked, must satisfy password complexity
Password confirmation
Required, must match the password field
After clicking on the register button, the user will get the message that an email confirmation is required to continue the process.
Figure 2. User registration – registration confirmation
Figure 3. User registration - An email confirmation message
Clicking on the provided link, the user will be redirected to the final screen that shows the confirmation message. With this final step of the registration process, the user account is created.
Users who try to use the system before completing the email confirmation will be presented with a message that email confirmation is required.
Figure 3. User registration – not confirmed an email
API descriptions
Dashboard page
A list of available APIs is available on the dashboard page after user login.
APIs are represented with the base route, icon, and summary. APIS can be filtered by tags.
API reference
If the user chooses the Explore button on the dashboard page he will be redirected to the API details page.
On API details of API are shown with a possibility to download YAML and JSON definition of API.
Access:
Base path api base path
Public mock URL
API key used for access API mock
The API key can be used as a query parameter or header parameter
https://api.bankapi.net/v1/correspondence/communications?contact-medium=email&statuses=pending&api-key=[api-key]
GET /v1/correspondence/communications?contact-medium=email&statuses=pending HTTP/1.1 Host: bankapi.net Content-Type: application/json X-Api-Key: 280d8cc4-352f-4899-8b1c-b8c20788ad08
From this page user can access API reference, Getting started tutorial. Change log, Problems, and classifications.
When accessing API references, the user can see details of API methods.
If your organization does not have access to some API method this method will be shown as public and it will be marked with red color in the context menu.
API events
If API definition contains events they will be shown in the menu. If you select menu item events will be rendered with examples. Context menu (All events) from left side is used for quick navigation through events.
