Início Rápido da API

A API pública do ANKK é uma API REST que permite gerenciar por programação suas operações multicanal em redes sociais usando uma única chave de API com escopo de marca (spk_...).

---

📌 Visão Geral dos Endpoints

• URL Base: https://api.ankk.app
• Swagger / Docs Interativos: https://api.ankk.app/v1/docs
• Especificação OpenAPI JSON: https://api.ankk.app/v1/openapi.json

---

1. Verificar a Integridade do Serviço

Endpoints de verificação de integridade (health check) não exigem cabeçalhos de autenticação.

curl https://api.ankk.app/v1/health

{
  "service": "api-public",
  "status": "ok"
}

---

2. Obter e Exportar sua Chave de API

No aplicativo web (https://app.ankk.app), navegue até Configurações da Marca → Chaves de API para gerar uma chave e, em seguida, exporte-a:

export ANKK_API_KEY='spk_live_xxxxxxxxxxxxxxxx'

---

3. Recuperar Marca e Conexões SNS

Verifique o status da sua marca e liste as contas SNS conectadas para obter os connection_ids de destino.

cURL

# 1. Inspect brand details
curl https://api.ankk.app/v1/brand \
  -H "Authorization: Bearer $ANKK_API_KEY"

# 2. List connected SNS accounts
curl https://api.ankk.app/v1/brand/connections \
  -H "Authorization: Bearer $ANKK_API_KEY"

TypeScript / JavaScript

const API_KEY = process.env.ANKK_API_KEY;
if (!API_KEY) throw new Error('Set ANKK_API_KEY');
const BASE_URL = 'https://api.ankk.app/v1';

const res = await fetch(`${BASE_URL}/brand/connections`, {
  headers: {
    Authorization: `Bearer ${API_KEY}`
  }
});
if (!res.ok) throw new Error(`Connections request failed: ${res.status}`);
const { items: connections } = await res.json();
console.log('Connected accounts:', connections);
const targetConnectionId = connections[0]?.connection_id;
if (!targetConnectionId) throw new Error('Connect an SNS account first');

Python

import os
import requests

API_KEY = os.environ['ANKK_API_KEY']
BASE_URL = 'https://api.ankk.app/v1'

headers = {'Authorization': f'Bearer {API_KEY}'}

response = requests.get(f'{BASE_URL}/brand/connections', headers=headers)
response.raise_for_status()
connections = response.json().get('items', [])
print(f'Connected accounts: {connections}')
target_connection_id = connections[0]['connection_id'] if connections else None
if not target_connection_id:
    raise RuntimeError('Connect an SNS account first')

---

4. Publicar seu Primeiro Conteúdo

Envie uma solicitação de publicação com uma idempotency_key gerada pelo cliente para evitar execuções duplicadas.

cURL

curl -X POST "https://api.ankk.app/v1/brand/contents" \
  -H "Authorization: Bearer $ANKK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connection_id": "conn_01jm8x9k2example",
    "idempotency_key": "my-first-post-001",
    "text": "Hello World from ANKK Public API! 🚀"
  }'

TypeScript / JavaScript

const publishRes = await fetch(`${BASE_URL}/brand/contents`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    connection_id: targetConnectionId,
    idempotency_key: 'my-first-post-001',
    text: 'Hello World from TypeScript! 🚀'
  })
});

if (publishRes.status !== 202) throw new Error(`Publish request failed: ${publishRes.status}`);
const result = await publishRes.json();
console.log('Publish accepted (HTTP 202):', result);

Python

payload = {
    'connection_id': target_connection_id,
    'idempotency_key': 'my-first-post-001',
    'text': 'Hello World from Python! 🚀',
}

publish_res = requests.post(
    f'{BASE_URL}/brand/contents',
    headers={**headers, 'Content-Type': 'application/json'},
    json=payload,
)
publish_res.raise_for_status()
print('Publish outcome:', publish_res.json())

---

5. Verificar o Status da Publicação

Uma solicitação bem-sucedida retorna HTTP 202 Accepted e um content_id. Verifique o status da entrega via:

curl "https://api.ankk.app/v1/brand/contents/$CONTENT_ID" \
  -H "Authorization: Bearer $ANKK_API_KEY"

---

🔗 Próximos Passos

• Autenticação e Escopos de Chave de API
• API de conteúdos e upload de mídia
• API de conexões
• Integração de Webhooks
• Referência da Ferramenta de CLI