Your Nexmo account can be managed in a few different ways:
- Via the Dashboard
- Using the CLI (command line interface) tool
- By calling the API directly or with one of the Nexmo Server SDKs for your preferred technology stack
Within your account you can check your balance, configure the account-level settings, and rotate your API secrets for security purposes.
The overall architecture is illustrated in the following diagram:
Each of the main items in the diagram is explained in more detail in the following sections.
Represents a relationship between clients and Nexmo. Each account is identified with a unique API key (account Id) and contains balance, settings, reports, and logs of Nexmo API usage.
Each account can be associated with one or more subaccounts. This division allows you to create a hierarchical structure to help manage product configuration, reporting, and billing.
An account divided into subaccounts is called a primary account, while subaccounts are considered to be collectively owned and controlled by the primary account. Only one level of hierarchy is allowed, so subaccounts cannot have their own subaccounts.
A primary user is created when a Nexmo account is created. There can only be a single primary user for the account and its subaccounts. A primary user can invite others to register as team members. A primary user defines management and oversight rights for new team members and the accounts/subaccounts that they will manage.
A team member, formerly referred to as a secondary user, represents a user that manages and configures one or more accounts via the Dashboard. Team members have usernames and passwords to login to the Dashboard, and different sets of permissions to define what they can manage via the Dashboard.
In order to make an API call with the Nexmo REST APIs, an API key (account ID) is required, as well as an associated API secret. Nexmo verifies that the secret is correct and bills the account identified by the API key.
- Nexmo Account Dashboard: How to use the Nexmo dashboard
Code snippets demonstrate how to use the API to perform various tasks.
- Configure account
- Get account balance
- Create a secret
- Revoke a secret
- List all secrets
- Fetch a secret