AltiviaCloud

Getting Started

  • Introduction
  • Quickstart
  • Authentication

API Reference

  • API Explorer
  • Orders
  • Webhooks

SDKs

  • Node.js
  • Python
  • PHP
  • Go
  • Java
  • C#
← Back to Dashboard

Quickstart

Get up and running with the AltiviaCloud API in minutes.

1. Create an API Key

Go to your Dashboard → API Keys and create a new key. Save it securely — it's only shown once.

2. Check your balance

cURL
curl https://api.altiviacloud.com.br/api/v1/balance \
  -H "Authorization: Bearer ac_live_YOUR_API_KEY"

3. List available countries

cURL
curl https://api.altiviacloud.com.br/api/v1/countries

4. Purchase a virtual number

cURL
curl -X POST https://api.altiviacloud.com.br/api/v1/orders \
  -H "Authorization: Bearer ac_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "countryId": "country_id_here",
    "serviceId": "service_id_here"
  }'

5. Get SMS messages

cURL
curl https://api.altiviacloud.com.br/api/v1/orders/ORDER_ID/sms \
  -H "Authorization: Bearer ac_live_YOUR_API_KEY"

Using an SDK

For a better developer experience, use one of our official SDKs.

Node.js
npm install @altiviacloud/sdk

import { AltiviaCloud } from "@altiviacloud/sdk";

const client = new AltiviaCloud("ac_live_YOUR_API_KEY");
const balance = await client.getBalance();
const order = await client.createOrder({ countryId, serviceId });