Provider API dokumentatsioon

Alustamine

JSON HTTPS-i kaudu. Saatke üks päring igal kliendi lüliti muutmisel. Iga päringu võib turvaliselt korrata.

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

Lõpp-punktid

Kordamine on ohutu

Sama externalId-ga päringud uuendavad seda klienti. Dubleerimist ei teki, nii et ajalõpu korral võite uuesti proovida.

Autentimine

Saatke oma võti igas päringus päises Authorization. Võtmed algavad anp_-ga, kuvatakse ainult korra ja neid saab lehel API-võtmed vahetada.

Authorization: Bearer anp_…

Aktiveeri või uuenda klient

POST/provider/clients

Saatke kliendi andmed, kui tema lüliti sisse lülitub. Sama externalId-ga korduv päring uuendab seda klienti.

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

Vastus

Iga päring tagastab kliendi oleku, kuulutuste arvud ja paketi.

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

Kliendi staatuse päring

GET/provider/clients/{externalId}

Tagastab kliendi praeguse oleku, kuulutuste arvud ja paketi samas vormis nagu aktiveerimise vastus.

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

Deaktiveeri klient

DELETE/provider/clients/{externalId}

Kliendi kustutamine lülitab ta välja ja eemaldab tema kuulutused Anutost.

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

Muutustest teatamine

POST/provider/clients/{externalId}/changes

Kutsuge seda alati, kui kliendi laoseis muutub: kuulutus luuakse, muudetakse, müüakse või kustutatakse. Me sünkroonime selle kliendi minutite jooksul, selle asemel et oodata regulaarset sünkroonimist iga paari tunni tagant. 5 minuti jooksul tehtud päringud ühendatakse, nii et seda võib kutsuda iga muutuse korral.

• Päringu sisu on valikuline. Lisage itemIds, et nimetada kuni 100 muutunud kinnisvara- või tootekirjet teie ID-dega.
• Edukas päring tagastab 202. nextSyncAt on aeg (UTC), millal uus sünkroonimine on ajastatud.
• Mitteaktiivse kliendi vastuses on queued: false ja teade. Midagi ei lisata järjekorda.

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

Võtme kontrollimine

GET/provider/me

Tagastab teie pakkuja nime, formaadid, mida teie juurdepääs hõlmab, ja võtme oleku. Kutsuge see esmalt välja, et kontrollida, kas uus võti töötab.

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

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

Testrežiim

Määrake test väärtuseks true, et kontrollida andmeid ja ühendust. Midagi ei looda; saate oleku, mis oleks tekkinud, ja kontrollide tulemused.

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

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

Kliendi olekud

• activeAktiivne ja sünkroonitud.
• pendingÜhendus ei tööta veel, seega midagi ei avaldata.
• reviewAnuto vaatab selle üle, sest selle uue kliendi e-post kuulub juba teisele Anuto kontole.
• inactiveTeie lülitasite välja või Anuto eemaldas.

Vead

Ebaõnnestunud päringud tagastavad JSON-i statusCode, code ja message. Otsustage code järgi; message on inimestele.

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

Päringupiirangud

Piiri ületamisel saate vastuseks 429 ja päise Retry-After. Oodake nii mitu sekundit ja proovige uuesti.