Provider API: Dokumentation

Erste Schritte

JSON über HTTPS. Senden Sie bei jeder Schalteränderung eines Kunden einen Aufruf. Jeder Aufruf kann gefahrlos wiederholt werden.

Basis-URLhttps://api.anuto.app/v1

Endpunkte

Wiederholen ist sicher

Aufrufe mit derselben externalId aktualisieren diesen Kunden. Es entstehen nie Duplikate, daher können Sie nach einem Timeout erneut senden.

Authentifizierung

Senden Sie Ihren Schlüssel bei jeder Anfrage im Header Authorization. Schlüssel beginnen mit anp_, werden nur einmal angezeigt und lassen sich auf der Seite „API-Schlüssel“ erneuern.

Authorization: Bearer anp_…

Kunden aktivieren oder aktualisieren

POST/provider/clients

Senden Sie die Daten des Kunden, wenn sein Schalter eingeschaltet wird. Ein erneuter Aufruf mit derselben externalId aktualisiert diesen Kunden.

curl -X POST https://api.anuto.app/v1/provider/clients \
  -H "Authorization: Bearer $ANUTO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "12345",
    "name": "Casa Sol Real Estate",
    "email": "[email protected]",
    "phone": "+34 600 000 000",
    "website": "https://casasol.es",
    "country": "ES",
    "listingsCount": 85
  }'

Antwort

Jeder Aufruf liefert Status, Inseratzahlen und Tarif des Kunden.

{
  "externalId": "12345",
  "clientId": "Xw3kQ9mZr2LpT7vNa4Bc",
  "status": "active",
  "shopUrl": "https://es.anuto.app/@casa-sol",
  "listings": { "active": 10, "waiting": 0, "planWaiting": 75 },
  "plan": { "tier": "free", "maxActive": 10, "freeMaxActive": 10 },
  "upgradeUrl": "https://es.anuto.app/user/manage/plan",
  "lastSyncAt": "2026-10-08T09:30:00.000Z"
}

Status eines Kunden abrufen

GET/provider/clients/{externalId}

Gibt den aktuellen Status des Kunden, die Anzahl der Anzeigen und den Tarif zurück, im gleichen Format wie die Antwort bei der Aktivierung.

curl https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Kunden deaktivieren

DELETE/provider/clients/{externalId}

Das Löschen eines Kunden schaltet ihn ab und zieht seine Inserate von Anuto zurück.

curl -X DELETE https://api.anuto.app/v1/provider/clients/12345 \
  -H "Authorization: Bearer $ANUTO_KEY"

Änderungen melden

POST/provider/clients/{externalId}/changes

Rufen Sie sie auf, wenn sich der Bestand eines Kunden ändert: Eine Anzeige wird erstellt, geändert, verkauft oder gelöscht. Wir synchronisieren diesen Kunden innerhalb von Minuten, statt auf die regelmäßige Synchronisierung alle paar Stunden zu warten. Aufrufe innerhalb von 5 Minuten werden zusammengeführt, deshalb ist ein Aufruf bei jeder Änderung in Ordnung.

• Der Body ist optional. Mit itemIds nennen Sie bis zu 100 Ihrer IDs von Objekten oder Produkten, die sich geändert haben.
• Ein erfolgreicher Aufruf liefert 202. nextSyncAt ist der Zeitpunkt (UTC), zu dem die erneute Synchronisierung geplant ist.
• Bei einem inaktiven Kunden enthält die Antwort queued: false und eine Meldung. Es wird nichts eingereiht.

curl -X POST https://api.anuto.app/v1/provider/clients/12345/changes \
  -H "Authorization: Bearer $ANUTO_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "itemIds": ["123", "456"] }'

{
  "queued": true,
  "nextSyncAt": "2026-10-08T12:00:00Z"
}

Schlüssel prüfen

GET/provider/me

Gibt Ihren Anbieternamen, die Formate, die Ihr Zugang abdeckt, und den Status des Schlüssels zurück. Rufen Sie es zuerst auf, um zu prüfen, ob ein neuer Schlüssel funktioniert.

curl https://api.anuto.app/v1/provider/me \
  -H "Authorization: Bearer $ANUTO_KEY"

{
  "providerId": "Xw3kQ9mZr2LpT7vNa4Bc",
  "name": "Your software company",
  "formats": ["…"],
  "status": "approved"
}

Testmodus

Setzen Sie test auf true, um Daten und Verbindung zu prüfen. Es wird nichts angelegt; Sie erhalten den Status, der sich ergeben würde, und die Prüfergebnisse.

{
  "externalId": "12345",
  "name": "Casa Sol Real Estate",
  "email": "[email protected]",
  "country": "ES",
  "test": true
}

{
  "ok": true,
  "wouldBe": "active",
  "checks": { "connection": "ok", "owner": "new_account" }
}

Kundenstatus

• activeOnline und synchronisiert.
• pendingDie Verbindung funktioniert noch nicht, daher wird nichts veröffentlicht.
• reviewAnuto prüft es, weil die E-Mail dieses neuen Kunden bereits zu einem anderen Anuto-Konto gehört.
• inactiveVon Ihnen ausgeschaltet oder von Anuto entfernt.

Fehler

Fehlgeschlagene Aufrufe liefern JSON mit statusCode, code und message. Reagieren Sie auf code; message ist für Menschen gedacht.

{
  "statusCode": 404,
  "code": "PROVIDER_CLIENT_NOT_FOUND",
  "message": "No client with externalId 12345"
}

Ratenlimits

Bei Überschreitung erhalten Sie 429 mit einem Retry-After-Header. Warten Sie so viele Sekunden und versuchen Sie es dann erneut.