HDVerityLawVerityLaw Docs
Help Center

Using API and Integrations

SOP manual for the API section covering overview metrics, key management, webhook review, documentation, and usage analytics, with honest notes on thin creation flows.

publicusers

Using API and Integrations

This page shows internal technical users how to use the current API section in VerityLaw. The section is useful for review, reference, and configuration capture, but some creation flows are still thinner than a full production console.

Product: VerityLaw
Module: API and Integrations
Role: Technical administrator, integration lead, developer, platform reviewer
Difficulty: Intermediate
Time: 10 to 12 minutes
Last Updated: 2026-03-10
Version: Current repo baseline

Before You Start

  • Sign in to the internal VerityLaw dashboard.
  • Know whether you need keys, webhook review, documentation, or usage analytics.
  • Treat visible forms carefully until you have confirmed what the page actually saves.

What is the API section?

The API section is the dashboard area for API usage review, key inventory, webhook inventory, API documentation, and usage analytics. It is partly operational and partly reference material.

When do you use this?

Use this section when you need to inspect API usage, review integration credentials, check webhook delivery health, or read the current API reference. Use it before you promise that a self-service key-issuance or webhook-registration flow is complete in your environment.

Where do you find it?

Primary path: Dashboard -> left sidebar -> API

Current routes:

  • /dashboard/api
  • /dashboard/api/keys
  • /dashboard/api/keys/new
  • /dashboard/api/webhooks
  • /dashboard/api/webhooks/new
  • /dashboard/api/webhooks/[id]
  • /dashboard/api/docs
  • /dashboard/api/usage

How do you work in this area?

Review the API overview

  1. Open API Overview.
  2. Review the cards for monthly calls, active keys, webhook success rate, and error rate.
  3. Check Top Endpoints and Recent Activity if data exists.
  4. Treat the page as an overview board. Empty tables simply mean no visible activity has been recorded yet.

Review API keys

  1. Open API Keys.
  2. Review the key Name, masked key ending, Tier, Created, Last Used, and Status.
  3. Use the key list to confirm whether an integration key already exists before you try to create a new one.

Understand the new-key form

  1. Open Create API Key.
  2. Review the available fields for key name, tier, rate limits, IP whitelist, and scopes.
  3. Confirm the intended tier and scope set before submitting anything.

The current page is a configuration form shell. It does not show a newly issued secret value or a visible persisted success flow on the page after submit.

Review webhooks

  1. Open Webhooks.
  2. Review the endpoint URL, subscribed events, success rate, last delivery, and status.
  3. Open a webhook detail page when you need the delivery log.
  4. Use the detail route to inspect retry counts, response codes, and response times.

Understand the new-webhook and detail flows

  1. Open Register Webhook to review URL, description, event selection, and retry options.
  2. Treat the page as a configuration screen unless you can confirm a saved result in your environment.
  3. On Webhook Detail, use the event-delivery log to inspect whether deliveries are actually succeeding.

The Send Test Event control is visible on the detail route, but the page does not show a completed in-page test workflow after the click.

Use the documentation and analytics routes

  1. Open Docs when you need the current reference page.
  2. Use it for the base URL, endpoint list, auth header, code examples, webhook-signature guidance, rate limits, and error codes.
  3. Open Usage when you need monthly request counts, top endpoints, average latency, plan summary, and billing summary.
  4. Treat the monthly usage chart area as a placeholder when no rendered chart is shown.

What if something does not look right?

"The list page works, but the create flow feels incomplete"

What it means: The current UI is stronger for inventory and review than for full self-service issuance.

What to do: Use the page to capture intended settings, then confirm creation through the owning technical process.

"A button returns me to an unexpected /api/... path"

What it means: Some page-level links use /api/... while the live dashboard section sits under /dashboard/api/....

What to do: Reopen the correct page from the API sidebar section if a button takes you out of the expected dashboard area.

"There is no usage data"

What it means: No visible API traffic has been recorded for the current environment or account.

What to do: Use the static docs and key list first, then return once traffic exists.

What's Next

Related Pages

Still Stuck?

  • Start again from the API sidebar group if a route opens in the wrong place.
  • Use the docs route for reference and the list routes for evidence.
  • Contact support: support@veva.co.za

Was this page helpful? [Yes] [No]