Zum Inhalt springen

Operative APIGehen Sie zur Website ↗

Armaturenbrett →

Achadu/Developers/API-Referenz

API-REFERENZ

Der gesamte öffentliche Betrieb, Endpunkt für Endpunkt.

REST v1-Vertrag mit JSON, einheitlicher Paginierung, vorhersehbaren Filtern und OpenAPI, bereit zur Generierung von Clients.

Basis und Format

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

FormatierenJSON UTF-8

AuthentifizierungBearer token

Versionv1 na URL

Standardlimit30 itens

Höchstgrenze100 itens

VertragOpenAPI 3.1.2

Alle Endpunkte

Die folgenden 121 Vorgänge sind in der Produktion verfügbar und verwenden dieselbe Kontoprüfung.

Suchvorgang

121 Operationen gefunden

GET/meKontoKonto ansehenGibt die mit dem Schlüssel verknüpfte Operation und den Akteur zurück.account:read→GET/offersAngeboteAngebote auflistenListen Sie Angebote mit Status-, Marktplatz- und Textfiltern auf.offers:read→POST/offersAngeboteAngebot erstellenErstellt ein ausstehendes Angebot, ohne es zu veröffentlichen.offers:write→GET/offers/{id}AngeboteAngebot ansehenGibt die redaktionellen und kommerziellen Details eines Angebots zurück.offers:read→PATCH/offers/{id}AngeboteAngebot aktualisierenAktualisiert nur die übermittelten Felder.offers:write→DELETE/offers/{id}AngeboteArchivangebotEntfernt das Angebot aus dem aktiven Flow, ohne den Verlauf zu löschen.offers:write→POST/offers/{id}/previewAngeboteVorschau des BeitragsStellen Sie die endgültige Nachricht zusammen, ohne sie an einen Kanal zu senden.offers:read→POST/offers/{id}/publishAngeboteAngebot postenStellt die Veröffentlichung des Angebots in eine Warteschlange für eine autorisierte Gruppe oder einen autorisierten Thread.publications:write→GET/groupsGruppenGruppen auflistenListet Gruppen auf, ohne JIDs, Sitzungen oder Anmeldeinformationen offenzulegen.groups:read→GET/groups/{id}GruppenGruppe anzeigenGibt eine sichere Betriebskonfiguration der Gruppe zurück.groups:read→PATCH/groups/{id}GruppenGruppe aktualisierenAktualisiert Name, Segment, Kapazität und Automatisierung.groups:write→GET/segmentsSegmenteSegmente auflistenListen Sie Nischen und Storefront-Konfigurationen auf.segments:read→POST/segmentsSegmenteSegment erstellenSchaffen Sie mit Ihrer Storefront-Einrichtung eine Nische.segments:write→GET/segments/{id}SegmenteSegment anzeigenGibt ein Segment der Operation zurück.segments:read→PATCH/segments/{id}SegmenteSegment aktualisierenAktualisiert die Identität, den Vertrieb und die Präsentation des Segments.segments:write→DELETE/segments/{id}SegmenteSegment löschenLöscht nur, wenn keine verknüpften Gruppen oder Kalender vorhanden sind.segments:write→GET/couponsGutscheineGutscheine auflistenListet aktive und verifizierte Coupons für den Vorgang auf.coupons:read→POST/couponsGutscheineGutschein erstellenRegistrieren Sie einen Gutschein, um ihn für Angebote zu verwenden.coupons:write→GET/coupons/{id}GutscheineGutschein ansehenRückgaberegeln und Gültigkeit eines Gutscheins.coupons:read→PATCH/coupons/{id}GutscheineGutschein aktualisierenAktualisiert Gültigkeit, Rabatt und Berechtigung.coupons:write→DELETE/coupons/{id}GutscheineGutschein aus dem ArchivDeaktivieren Sie den Coupon unter Beibehaltung seiner Historie.coupons:write→GET/commissionsProvisionenProvisionen auflistenListet die dem Konto zugewiesenen Provisionen auf.commissions:read→GET/commissions/summaryProvisionenProvisionen zusammenfassenGruppiert Beträge nach Währung und Zahlungsstatus.commissions:read→GET/commissions/{id}ProvisionenSiehe ProvisionRetourenzuordnung und Abgleich einer Provision.commissions:read→GET/publicationsVeröffentlichungenVeröffentlichungen auflistenListen Sie Sendungen mit Filtern nach Bundesstaat, Gruppe und Angebot auf.publications:read→GET/publications/{id}VeröffentlichungenPublikation ansehenGibt das Ergebnis einer Veröffentlichung zurück, ohne die Kanalsitzung verfügbar zu machen.publications:read→GET/templatesVorlagenListenvorlagenRedaktionelle Vorlagen für das Konto auflisten.templates:read→POST/templatesVorlagenVorlage erstellenErstellt eine wiederverwendbare Veröffentlichungsvorlage.templates:write→GET/templates/{id}VorlagenVorlage ansehenGibt den Hauptteil und die Konfiguration einer Vorlage zurück.templates:read→PATCH/templates/{id}VorlagenVorlage aktualisierenAktualisiert die von der Vorlage gesendeten Felder.templates:write→DELETE/templates/{id}VorlagenVorlage löschenLöscht eine Vorlage, die nicht von Zeitplänen verwendet wird.templates:write→GET/schedulesZeitpläneTermine auflistenListet zukünftige und wiederkehrende Veröffentlichungen auf.schedules:read→POST/schedulesZeitpläneZeitplan erstellenProgrammangebot oder Text für einen ISO-Termin.schedules:write→GET/schedules/{id}ZeitpläneZeitplan ansehenGibt Ziel, Inhalt und Wiederholung zurück.schedules:read→PATCH/schedules/{id}ZeitpläneZeitplan aktualisierenÄndern Sie Zeit, Ziel, Wiederholung oder Status.schedules:write→DELETE/schedules/{id}ZeitpläneZeitplan löschenBricht einen zukünftigen Zeitplan ab und entfernt ihn.schedules:write→POST/schedules/{id}/runZeitpläneAusführungsplanEs führt jetzt dieselbe sichere Routine aus wie der Scheduler.publications:write→GET/monitorsMonitoreRadargeräte auflistenListet automatische Angebotserkennungsregeln auf.monitors:read→POST/monitorsMonitoreRadar erstellenErstellen Sie eine wiederkehrende Suche mit kommerziellen Kriterien.monitors:write→GET/monitors/{id}MonitoreRadar anzeigenGibt Kriterien und das letzte Ergebnis einer Regel zurück.monitors:read→PATCH/monitors/{id}MonitoreRadar aktualisierenAktualisierungskriterien, Häufigkeit und Automatisierung.monitors:write→DELETE/monitors/{id}MonitoreRadar löschenEntfernt eine Überwachungsregel.monitors:write→GET/storeSpeichernShop ansehenGibt nur die öffentliche Konfiguration des Stores zurück.store:read→PATCH/storeSpeichernStore aktualisierenAktualisiert die Identität, das Thema, die Netzwerke und den Datenschutz.store:write→GET/journeysReisenReisen auflistenListet DU-Flüsse und Gesamtleistung auf.journeys:read→POST/journeysReisenReise erstellenErstellt zunächst eine sichere visuelle Automatisierung.journeys:write→GET/journeys/{id}ReisenSiehe ReiseGibt Journey-Blöcke, Kanäle und Metriken zurück.journeys:read→PATCH/journeys/{id}ReisenReise aktualisierenAktualisiert die Diagramm- und Reiseregeln.journeys:write→DELETE/journeys/{id}ReisenReise löschenAusgeschlossen sind nur Fahrten, die noch nie durchgeführt wurden.journeys:write→POST/journeys/{id}/activateReisenReise aktivierenAktivieren oder pausieren Sie eine bestehende Reise.journeys:write→GET/inbox/conversationsPosteingangGespräche auflistenListet die Betriebsmetadaten des DU-Posteingangs auf.inbox:read→GET/inbox/conversations/{id}PosteingangKonversation ansehenGibt den Konversationskontext ohne direkte Kontaktdaten zurück.inbox:read→PATCH/inbox/conversations/{id}PosteingangKonversation aktualisierenWeist den DU-Modus zu, priorisiert ihn oder ändert ihn.inbox:write→POST/inbox/conversations/{id}/closePosteingangGespräch beendenBeenden Sie das Gespräch und zeichnen Sie das Ereignis auf.inbox:write→GET/inbox/conversations/{id}/messagesPosteingangNachrichten auflistenListet den paginierten Verlauf einer Konversation auf.inbox:read→POST/inbox/conversations/{id}/replyPosteingangBereiten Sie die Antwort vorRegistriert eine Ausgabeantwort zur Übermittlung durch den Kanal-Connector.inbox:write→GET/inbox/contactsPosteingangKontakte auflistenGeben Sie Ihr Profil, Ihr Praktikum und Ihr Interesse an, ohne Ihre Telefonnummer oder E-Mail preiszugeben.inbox:read→GET/analytics/summaryAnalytikAnalytics-ZusammenfassungKonsolidiert Angebote, Veröffentlichungen, Klicks und Provisionen.analytics:read→GET/analytics/timeseriesAnalytikZeitreihenGruppiert Beiträge, Fehler und Klicks nach Tag.analytics:read→GET/analytics/groupsAnalytikLeistung pro GruppeVergleicht Volumen, Lieferung und Fehler zwischen Gruppen.analytics:read→GET/analytics/offersAnalytikLeistung nach AngebotSortieren Sie Angebote nach Veröffentlichung, Klick und Provision.analytics:read→GET/analytics/sourcesAnalytikLeistung nach QuelleGruppiert Katalog, Klicks und Umsatz nach Marktplatz.analytics:read→GET/analytics/heatmapAnalytikInteraktions-HeatmapAggregiert Klicks nach Seite, Element, Tag und Uhrzeit.analytics:read→POST/links/convertLinksLink konvertierenKonvertiert eine URL nur unter Verwendung der Integrationen dieses Kontos.links:write→GET/webhooksWebhooksWebhooks auflistenListen Sie Reiseziele und Veranstaltungen auf, niemals das Geheimnis.webhooks:read→POST/webhooksWebhooksWebhook erstellenErstellt ein HTTPS-Ziel und gibt das Geheimnis einmal preis.webhooks:write→GET/webhooks/{id}WebhooksWebhook anzeigenGibt die sichere Konfiguration des Ziels zurück.webhooks:read→PATCH/webhooks/{id}WebhooksWebhook aktualisierenAktualisieren Sie URL, Ereignisse oder Status, ohne das Geheimnis zu ändern.webhooks:write→DELETE/webhooks/{id}WebhooksWebhook löschenEntfernt den Ziel- und Lieferverlauf.webhooks:write→GET/webhooks/{id}/deliveriesWebhooksLieferungen auflistenListet Versuche, HTTP-Status und Zustellungsfehler auf.webhooks:read→POST/groupsGruppenGruppenziel erstellenRegistriert eine Gruppe, die bereits vom Konto-Connector autorisiert wurde.groups:write→DELETE/groups/{id}GruppenArchivgruppeDeaktivieren Sie das Ziel, ohne den Veröffentlichungsverlauf zu löschen.groups:write→GET/groups/{id}/activityGruppenÜberprüfen Sie die GruppenaktivitätFassen Sie Ein- und Austritte sowie Veröffentlichungen zusammen, ohne die Teilnehmer preiszugeben.groups:read→POST/publications/{id}/retryVeröffentlichungenVersuchen Sie es noch einmal mit der VeröffentlichungErstellt einen Wiederholungsversuch für einen fehlgeschlagenen Beitrag.publications:write→POST/publications/{id}/cancelVeröffentlichungenVeröffentlichung aufhebenBricht eine ausstehende Veröffentlichung ab, ohne den Verlauf zu entfernen.publications:write→GET/publications/{id}/attemptsVeröffentlichungenVeröffentlichungsversuche auflistenListet die sichere Zeitleiste für Erstellung, Fehler, Wiederholung und Abbruch auf.publications:read→POST/commissions/importsProvisionenImportieren Sie Provisionen in CSVNormalisiert eine CSV-Datei, dedupliziert Transaktionen und erstellt eine überprüfbare Quittung.commissions:write→GET/commissions/importsProvisionenProvisionsimporte auflistenListen Sie Importbelege auf, ohne Anmeldeinformationen anzugeben.commissions:read→GET/commissions/imports/{id}ProvisionenSiehe ProvisionsimportGibt Anzahl, normalisierte Fehler und den Ursprung eines Imports zurück.commissions:read→POST/commissions/syncProvisionenProvisionen synchronisierenFragen Sie nur autorisierte Konnektoren ab und erfassen Sie einen Beleg pro Quelle.commissions:write→GET/commissions/receiptsProvisionenQuittungen auflistenListet Finanzgutschriften und den Abgleichsstatus auf.commissions:read→POST/commissions/receiptsProvisionenQuittung registrierenRegistriert eine erhaltene Gutschrift, ohne diese automatisch als Provision zu behandeln.commissions:write→GET/commissions/receipts/{id}ProvisionenQuittung ansehenGibt die Quittung und die abgeglichenen Provisionen zurück.commissions:read→POST/commissions/receipts/{id}/reconcileProvisionenBeleg abgleichenWählen Sie automatisch die Provisionen aus, aus denen die Gutschrift besteht, oder erhalten Sie sie.commissions:write→POST/monitors/{id}/runMonitoreFühren Sie jetzt Radar ausFührt eine Runde des Radars aus und das beobachtete Ergebnis bleibt bestehen.monitors:write→GET/monitors/{id}/resultsMonitoreKonsultieren Sie die RadarergebnisseGibt die letzte Runde und Angebote zurück, die von diesem Radar stammen.monitors:read→GET/store/collectionsSpeichernStore-Kollektionen auflistenListet redaktionelle Sammlungen und ihre öffentliche Ordnung auf.store:read→POST/store/collectionsSpeichernShop-Kollektion erstellenErstellt eine veröffentlichungsfähige Sammlung von Angeboten.store:write→GET/store/collections/{id}SpeichernShop-Kollektion ansehenGibt Inhalt und Konfiguration einer Sammlung zurück.store:read→PATCH/store/collections/{id}SpeichernStore-Sammlung aktualisierenBei Aktualisierungen werden nur gesendete Felder aus der Sammlung aktualisiert.store:write→DELETE/store/collections/{id}SpeichernStore-Sammlung löschenEntfernen Sie die Sammlung, ohne die Angebote zu löschen.store:write→GET/store/pagesSpeichernStore-Seiten auflistenListen Sie Zielseiten und redaktionelle Inhalte für den Shop auf.store:read→POST/store/pagesSpeichernShop-Seite erstellenErstellen Sie eine Seite in Markdown mit eigener SEO.store:write→GET/store/pages/{id}SpeichernStore-Seite anzeigenGibt Inhalt, SEO und Veröffentlichungsstatus zurück.store:read→PATCH/store/pages/{id}SpeichernStore-Seite aktualisierenAktualisieren Sie Inhalte, Slugs, SEOs oder Beiträge.store:write→DELETE/store/pages/{id}SpeichernStore-Seite löschenEntfernt eine separate Seite aus dem Store.store:write→GET/inbox/contacts/{id}PosteingangSiehe KontaktGibt Profil, Tags und Aktivität ohne direkte Kennungen zurück.inbox:read→PATCH/inbox/contacts/{id}PosteingangKontakt aktualisierenAktualisiert Name, Phase, Tags und autorisierte Einstellungen.inbox:write→GET/inbox/contacts/{id}/notesPosteingangKontaktnotizen auflistenListet interne Notizen mit Autor und Datum auf.inbox:read→POST/inbox/contacts/{id}/notesPosteingangNotiz im Kontakt erstellenZeichnet eine interne Notiz auf, die niemals an den Kontakt gesendet wird.inbox:write→POST/inbox/conversations/{id}/assignPosteingangGespräch zuordnenWeist die für die Konversation verantwortliche Person zu oder entfernt sie.inbox:write→POST/inbox/conversations/{id}/reopenPosteingangKonversation erneut eröffnenÖffnet ein geschlossenes Gespräch erneut und zeichnet das Ereignis auf.inbox:write→GET/inbox/messages/{id}PosteingangNachricht ansehenGibt den Inhalt und den Betriebsstatus einer Nachricht zurück.inbox:read→GET/inbox/messages/{id}/statusPosteingangÜberprüfen Sie die NachrichtenzustellungUnterscheiden Sie zwischen „vorbereitet“, „in der Warteschlange“, „gesendet“, „zugestellt“ und „fehlgeschlagen“.inbox:read→POST/journeys/{id}/validateReisenReise validierenÜberprüft Trigger, Blöcke, Kanäle und Referenzen, ohne den Flow auszuführen.journeys:read→POST/journeys/{id}/executeReisenLaufreiseStartet eine explizite Ausführung für autorisierte Kontakte oder Gespräche.journeys:write→GET/journeys/{id}/executionsReisenReisedurchführungen auflistenListen Sie Status, Schritt und Zeiten der Ausführungen auf.journeys:read→GET/journey-executions/{id}ReisenReiseausführung anzeigenGibt die Ausführung und ihren sicheren Betriebskontext zurück.journeys:read→GET/webhook-eventsWebhooksWebhook-Ereignisse auflistenGibt den versionierten Katalog von Ereignissen und Beschreibungen zurück.webhooks:read→GET/webhook-events/{event}/schemaWebhooksEreignisschema anzeigenGibt das JSON-Schema und ein Beispiel des Ereignisses in der aktuellen Version zurück.webhooks:read→POST/webhooks/{id}/rotate-secretWebhooksWebhook-Geheimnis drehenMacht das vorherige Geheimnis ungültig und enthüllt das neue nur einmal.webhooks:write→POST/webhooks/{id}/testWebhooksTesten Sie den WebhookStellt ein signiertes Testereignis in die Warteschlange des Ziels.webhooks:write→POST/webhook-deliveries/{id}/redeliverWebhooksWebhook-Zustellung erneut sendenErstellt einen überprüfbaren Wiederholungsversuch für einen vorhandenen Liefergegenstand.webhooks:write→GET/integrationsIntegrationenIntegrationen auflistenListet Connectors und den sicheren Status auf, ohne Anmeldeinformationen zurückzugeben.integrations:read→GET/integrations/{provider}IntegrationenSiehe IntegrationGibt Kapazität, Zustand und letzte Validierung eines Connectors zurück.integrations:read→GET/integrations-healthIntegrationenÜberprüfen Sie den IntegrationszustandFasst Konnektoren zusammen, die konfiguriert und fehlerfrei sind und Aufmerksamkeit erfordern.integrations:read→POST/integrations/{provider}/testIntegrationenIntegration validierenValidiert die verfügbare Konfiguration und zeichnet die Diagnose auf.integrations:write→DELETE/integrations/{provider}IntegrationenTrennen Sie die IntegrationEntfernt die Connector-Anmeldeinformationen für den Hauptakteur.integrations:write→GET/analytics/funnelAnalytikTrichter analysierenGruppiert Impression, Klick, Absicht, Kauf und Provision nach Zeitraum.analytics:read→GET/analytics/revenueAnalytikRezept analysierenKonsolidiert registrierte Provisionen und Einnahmen, die nach Währung abgeglichen sind.analytics:read→GET/analytics/attributionAnalytikAttribution analysierenVergleicht Quelle, Gruppe, Segment und Konvertierungsfenster.analytics:read→

Filter und Paginierung

Sammlungen akzeptieren Limit und Offset. Angebote, Veröffentlichungen, Gespräche und Analysen verfügen über zusätzliche Filter, die in OpenAPI beschrieben werden.

offersstatus, marketplace, query

publicationsstatus, group_id, offer_id

inbox/conversationsstatus, channel

analytics/*days: 1–365

Erstellen Sie ein ausstehendes Angebot

Die Erstellung erfolgt URL-idempotent. Eine vorhandene URL gibt das aktuelle Element zurück; nichts wird automatisch veröffentlicht.

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"
  }'