Admin tasks

First admin (once, at install)

The SMPP portal has its own accounts. The first admin is made once:

1. Set ADMIN_BOOTSTRAP_KEY in the yanu-smpp env file on the server.
2. Call POST https://smpp.smsyanu.com/api/v1/auth/setup with bootstrap_key, email, name and a password of at least 10 characters.
3. It works only while no admin exists. After that, remove or change ADMIN_BOOTSTRAP_KEY.

Staff can also sign in with their yanu-auth account. A yanu-auth super admin with a verified email is an admin in the portal.

Create an account

1. Accounts, then New. Enter email, name and role: user (client), reseller or admin.
2. For a reseller's client, pick the parent reseller.
3. Either set a password (at least 10 characters) and give it to the person safely, or let them sign in with their yanu-auth account using the same email.

Create an SMPP bind

1. Binds, then New bind.
2. Pick the owner, the countries, a label, the client's public IPs and the throughput (1 to 500 per second, default 20).
3. Optional: a session limit, a fixed price per SMS for this bind, or your own system_id (lower-case letters and digits, up to 15).
4. Save. The password is shown once: give it to the client safely, or let them reset it in the portal.
5. The bind starts at 0 SMS. It is locked in the gateway to its countries.

A bind with several countries is priced at the highest of its country prices, unless you set a fixed price.

Enable countries

• Pricing: turn a country on and set its price in MWK and USD. A country needs a price before binds in it can be topped up.
• For a bind: edit the bind and change its countries.
• For a reseller: Resellers, pick the reseller, set its countries with a wholesale price in MWK and USD each. The reseller can only create binds in these countries.

Credit a balance

• A bind: Binds, pick the bind, Credit. Enter the SMS (negative to remove), the payment reference and a note.
• A reseller pool: Resellers, pick the reseller, Add SMS, pick the country.
• SMS dashboard account (money): in the account service admin (manual credit with a reason).

Every credit carries an idempotency key. The portal makes one for you, so a double click or a retry never credits twice. If you call the API yourself, use a new key (8 to 120 characters) for each credit and reuse it only to retry the same credit.

Always write the payment reference. Never credit without one.

Approve top-ups

1. Top-ups. Pending requests from direct clients are listed. Reseller clients' requests go to their reseller.
2. Match each one to a payment in the bank or mobile money statement: amount, currency and reference.
3. Approve if all match. The SMS were counted at the price locked when the client submitted. Reject with a note if not.
4. A reference can back one live request only. A rejected request frees it.
5. If a request ends as being checked, see Stuck top-ups.

Read reports

• Reports lists traffic. Filter by bind, country, status, date, or part of a number.
• The summary gives totals per day and per country.
• Export CSV for billing or for a customer's question.
• Ledger shows every SMS movement. Audit log shows who changed what.