Pular para o conteúdo

API de conexões

A API de conexões permite listar e consultar as contas de redes sociais vinculadas à sua marca (Instagram, Threads, Bluesky, Página do Facebook, TikTok e YouTube). Use-a para obter os connection_id de destino e verificar as permissões antes de publicar conteúdo.


MétodoCaminhoDescriçãoEscopo Necessário
GET/v1/brand/connectionsLista contas SNS conectadas com filtragem opcional por plataformaconnections:read ou *
GET/v1/brand/connections/{connection_id}Recupera detalhes da conexão e diagnósticos de autorização em tempo realconnections:read ou *

Recupera todas as contas SNS conectadas sob a marca.

ParâmetroTipoObrigatórioDescrição
sns_typestringOpcionalFiltrar por instagram, threads, bluesky, facebook_page, tiktok ou youtube
Terminal window
curl -X GET "https://api.ankk.app/v1/brand/connections?sns_type=instagram" \
-H "Authorization: Bearer spk_live_xxxxxxxx"
{
"items": [
{
"id": "conn_01jm8x9k2example",
"sns_type": "instagram",
"platform": "meta.instagram",
"display_name": "ACME Official",
"username": "acme_official",
"profile_image_url": "https://example.com/profiles/acme.jpg",
"status": "connected",
"created_at": "2026-08-01T10:00:00Z"
}
]
}

🔍 Obter Detalhes da Conexão (GET /v1/brand/connections/{connection_id})

Seção intitulada “🔍 Obter Detalhes da Conexão (GET /v1/brand/connections/{connection_id})”

Recupera detalhes da conexão juntamente com diagnósticos de Autorização de Publicação em tempo real.

Terminal window
curl -X GET "https://api.ankk.app/v1/brand/connections/conn_01jm8x9k2example" \
-H "Authorization: Bearer spk_live_xxxxxxxx"
{
"id": "conn_01jm8x9k2example",
"sns_type": "instagram",
"platform": "meta.instagram",
"display_name": "ACME Official",
"username": "acme_official",
"profile_image_url": "https://example.com/profiles/acme.jpg",
"status": "connected",
"created_at": "2026-08-01T10:00:00Z",
"publish_authorization": {
"status": "scope_authorized",
"required_scopes": ["instagram_business_basic", "instagram_business_content_publish"],
"missing_scopes": [],
"retryable": false
}
}

Códigos de Status de Autorização (publish_authorization.status)

Seção intitulada “Códigos de Status de Autorização (publish_authorization.status)”
StatusSignificado e Ação
scope_authorizedTotalmente autorizado. Pronto para publicar.
scope_permission_unverifiedVerificação pendente. A publicação pode ser tentada.
scope_permission_missingEscopos obrigatórios ausentes. Reautorização necessária na Interface Web.
scope_review_disabledBloqueado pelo status de revisão do aplicativo da plataforma ou limites do modo de desenvolvedor.
unsupportedOperação não suportada nesta conexão.