Pular para o conteúdo

API operacionalIr para o site ↗

Achadu/Developers/Referência da API

REFERÊNCIA DA API

Toda a operação pública, endpoint por endpoint.

Contrato REST v1 com JSON, paginação uniforme, filtros previsíveis e OpenAPI pronta para gerar clientes.

Base e formato

BASE URLhttps://achadu.com/api/v1OpenAPI ↗

FormatoJSON UTF-8

AutenticaçãoBearer token

Versãov1 na URL

Limite padrão30 itens

Limite máximo100 itens

ContratoOpenAPI 3.1.2

Todos os endpoints

As 70 operações abaixo estão disponíveis em produção e usam a mesma auditoria da conta.

Buscar operação

70 operações encontradas

GET/meAccountVer contaRetorna a operação e o ator vinculados à chave.account:read→GET/offersOffersListar ofertasLista ofertas com filtros de status, marketplace e texto.offers:read→POST/offersOffersCriar ofertaCria uma oferta pendente sem publicá-la.offers:write→GET/offers/{id}OffersVer ofertaRetorna os detalhes editoriais e comerciais de uma oferta.offers:read→PATCH/offers/{id}OffersAtualizar ofertaAtualiza somente os campos enviados.offers:write→DELETE/offers/{id}OffersArquivar ofertaRetira a oferta do fluxo ativo sem apagar o histórico.offers:write→POST/offers/{id}/previewOffersPré-visualizar publicaçãoMonta a mensagem final sem enviar para nenhum canal.offers:read→POST/offers/{id}/publishOffersPublicar ofertaEnfileira a publicação da oferta em um grupo ou segmento autorizado.publications:write→GET/groupsGroupsListar gruposLista grupos sem expor JIDs, sessões ou credenciais.groups:read→GET/groups/{id}GroupsVer grupoRetorna configuração operacional segura do grupo.groups:read→PATCH/groups/{id}GroupsAtualizar grupoAtualiza nome, segmento, capacidade e automação.groups:write→GET/segmentsSegmentsListar segmentosLista nichos e configurações de vitrine.segments:read→POST/segmentsSegmentsCriar segmentoCria um nicho com sua configuração de vitrine.segments:write→GET/segments/{id}SegmentsVer segmentoRetorna um segmento da operação.segments:read→PATCH/segments/{id}SegmentsAtualizar segmentoAtualiza identidade, distribuição e vitrine do segmento.segments:write→DELETE/segments/{id}SegmentsExcluir segmentoExclui somente quando não existem grupos ou agendas vinculados.segments:write→GET/couponsCouponsListar cuponsLista cupons ativos e verificados da operação.coupons:read→POST/couponsCouponsCriar cupomRegistra um cupom para uso nas ofertas.coupons:write→GET/coupons/{id}CouponsVer cupomRetorna regras e validade de um cupom.coupons:read→PATCH/coupons/{id}CouponsAtualizar cupomAtualiza validade, desconto e elegibilidade.coupons:write→DELETE/coupons/{id}CouponsArquivar cupomDesativa o cupom preservando seu histórico.coupons:write→GET/commissionsCommissionsListar comissõesLista comissões atribuídas à conta.commissions:read→GET/commissions/summaryCommissionsResumir comissõesAgrupa valores por moeda e estado de pagamento.commissions:read→GET/commissions/{id}CommissionsVer comissãoRetorna atribuição e conciliação de uma comissão.commissions:read→GET/publicationsPublicationsListar publicaçõesLista envios com filtros por estado, grupo e oferta.publications:read→GET/publications/{id}PublicationsVer publicaçãoRetorna o resultado de uma publicação sem expor sessão do canal.publications:read→GET/templatesTemplatesListar templatesLista modelos editoriais da conta.templates:read→POST/templatesTemplatesCriar templateCria um modelo reutilizável de publicação.templates:write→GET/templates/{id}TemplatesVer templateRetorna o corpo e a configuração de um template.templates:read→PATCH/templates/{id}TemplatesAtualizar templateAtualiza os campos enviados do template.templates:write→DELETE/templates/{id}TemplatesExcluir templateExclui um template sem uso por agendamentos.templates:write→GET/schedulesSchedulesListar agendamentosLista publicações futuras e recorrentes.schedules:read→POST/schedulesSchedulesCriar agendamentoPrograma oferta ou texto para uma data ISO.schedules:write→GET/schedules/{id}SchedulesVer agendamentoRetorna destino, conteúdo e recorrência.schedules:read→PATCH/schedules/{id}SchedulesAtualizar agendamentoAltera horário, destino, recorrência ou estado.schedules:write→DELETE/schedules/{id}SchedulesExcluir agendamentoCancela e remove um agendamento futuro.schedules:write→POST/schedules/{id}/runSchedulesExecutar agendamentoExecuta agora a mesma rotina segura do agendador.publications:write→GET/monitorsMonitorsListar radaresLista regras automáticas de descoberta de ofertas.monitors:read→POST/monitorsMonitorsCriar radarCria uma busca recorrente com critérios comerciais.monitors:write→GET/monitors/{id}MonitorsVer radarRetorna critérios e último resultado de uma regra.monitors:read→PATCH/monitors/{id}MonitorsAtualizar radarAtualiza critérios, frequência e automação.monitors:write→DELETE/monitors/{id}MonitorsExcluir radarRemove uma regra de monitoramento.monitors:write→GET/storeStoreVer lojaRetorna somente a configuração pública da loja.store:read→PATCH/storeStoreAtualizar lojaAtualiza identidade, tema, redes e privacidade da loja.store:write→GET/journeysJourneysListar jornadasLista fluxos do DU e desempenho agregado.journeys:read→POST/journeysJourneysCriar jornadaCria uma automação visual inicialmente segura.journeys:write→GET/journeys/{id}JourneysVer jornadaRetorna blocos, canais e métricas da jornada.journeys:read→PATCH/journeys/{id}JourneysAtualizar jornadaAtualiza o grafo e as regras da jornada.journeys:write→DELETE/journeys/{id}JourneysExcluir jornadaExclui apenas jornadas que nunca foram executadas.journeys:write→POST/journeys/{id}/activateJourneysAtivar jornadaAtiva ou pausa uma jornada existente.journeys:write→GET/inbox/conversationsInboxListar conversasLista metadados operacionais do DU Inbox.inbox:read→GET/inbox/conversations/{id}InboxVer conversaRetorna contexto da conversa sem dados diretos do contato.inbox:read→PATCH/inbox/conversations/{id}InboxAtualizar conversaAtribui, prioriza ou altera o modo do DU.inbox:write→POST/inbox/conversations/{id}/closeInboxEncerrar conversaEncerra a conversa e registra o evento.inbox:write→GET/inbox/conversations/{id}/messagesInboxListar mensagensLista o histórico paginado de uma conversa.inbox:read→POST/inbox/conversations/{id}/replyInboxPreparar respostaRegistra uma resposta de saída para entrega pelo conector do canal.inbox:write→GET/inbox/contactsInboxListar contatosLista perfil, estágio e interesse sem expor telefone ou e-mail.inbox:read→GET/analytics/summaryAnalyticsResumo de analyticsConsolida ofertas, publicações, cliques e comissões.analytics:read→GET/analytics/timeseriesAnalyticsSérie temporalAgrupa publicações, falhas e cliques por dia.analytics:read→GET/analytics/groupsAnalyticsDesempenho por grupoCompara volume, entrega e erro entre grupos.analytics:read→GET/analytics/offersAnalyticsDesempenho por ofertaOrdena ofertas por publicação, clique e comissão.analytics:read→GET/analytics/sourcesAnalyticsDesempenho por fonteAgrupa catálogo, clique e receita por marketplace.analytics:read→GET/analytics/heatmapAnalyticsHeatmap de interaçãoAgrega cliques por página, elemento, dia e hora.analytics:read→POST/links/convertLinksConverter linkConverte uma URL usando apenas as integrações desta conta.links:write→GET/webhooksWebhooksListar webhooksLista destinos e eventos, nunca o segredo.webhooks:read→POST/webhooksWebhooksCriar webhookCria um destino HTTPS e revela o segredo uma única vez.webhooks:write→GET/webhooks/{id}WebhooksVer webhookRetorna configuração segura do destino.webhooks:read→PATCH/webhooks/{id}WebhooksAtualizar webhookAtualiza URL, eventos ou estado sem trocar o segredo.webhooks:write→DELETE/webhooks/{id}WebhooksExcluir webhookRemove destino e histórico de entregas.webhooks:write→GET/webhooks/{id}/deliveriesWebhooksListar entregasLista tentativas, HTTP status e erros de entrega.webhooks:read→

Filtros e paginação

Coleções aceitam limit e offset. Ofertas, publicações, conversas e analytics possuem filtros adicionais descritos no OpenAPI.

offersstatus, marketplace, query

publicationsstatus, group_id, offer_id

inbox/conversationsstatus, channel

analytics/*days: 1–365

Criar uma oferta pendente

A criação é idempotente por URL. Uma URL existente retorna o item atual; nada é publicado automaticamente.

bash

curl -X POST https://achadu.com/api/v1/offers \
  -H "Authorization: Bearer ach_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.amazon.com.br/dp/...",
    "title": "Air fryer 5L",
    "price": 329.90,
    "currency": "BRL",
    "coupon": "CASA10"
  }'