Provider API dokumentáció

Első lépések

JSON HTTPS-en keresztül. Ügyfelenként egy hívást küldj, valahányszor a kapcsolója változik. Minden hívás biztonságosan megismételhető.

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

Végpontok

Az ismétlés biztonságos

Az ugyanazzal az externalId-val érkező hívások frissítik az ügyfelet. Sosem hoznak létre duplikátumot, így időtúllépés után nyugodtan újrapróbálkozhatsz.

Hitelesítés

Minden kérésben küldd el a kulcsodat az Authorization fejlécben. A kulcsok anp_ előtaggal kezdődnek, csak egyszer látszanak, és az API-kulcsok oldalon lecserélhetők.

Authorization: Bearer anp_…

Ügyfél aktiválása vagy frissítése

POST/provider/clients

Amikor az ügyfél kapcsolója bekapcsol, küldd el az adatait. Ugyanazzal az externalId-val ismételt hívás frissíti ezt az ügyfelet.

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

Válasz

Minden hívás visszaadja az ügyfél állapotát, a hirdetésszámokat és a csomagot.

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

Egy ügyfél állapotának lekérdezése

GET/provider/clients/{externalId}

Visszaadja az ügyfél aktuális állapotát, a hirdetések számát és a csomagot, ugyanabban a formában, mint az aktiválás válasza.

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

Ügyfél deaktiválása

DELETE/provider/clients/{externalId}

Az ügyfél törlése kikapcsolja, és visszavonja a hirdetéseit az Anutóról.

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

Változások jelzése

POST/provider/clients/{externalId}/changes

Hívd meg, valahányszor változik egy ügyfél készlete: hirdetés jön létre, módosul, elkel vagy törlődik. Az ügyfelet perceken belül újraszinkronizáljuk, ahelyett hogy megvárnánk az néhány óránként futó rendszeres szinkront. Az 5 percen belüli hívásokat összevonjuk, így minden változásnál hívhatod.

• A törzs nem kötelező. Az itemIds mezővel legfeljebb 100, megváltozott ingatlan- vagy termékazonosítódat adhatod meg.
• Sikeres hívás 202-t ad vissza. A nextSyncAt az az időpont (UTC), amikor az újraszinkronizálás esedékes.
• Inaktív ügyfél esetén a válasz queued: false értéket és üzenetet tartalmaz. Semmi sem kerül sorba.

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

Kulcs ellenőrzése

GET/provider/me

Visszaadja a szolgáltatód nevét, a hozzáféréseddel lefedett formátumokat és a kulcs állapotát. Új kulcs működését először ezzel ellenőrizd.

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

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

Tesztmód

Állítsd a test mezőt true értékre az adatok érvényesítéséhez és a kapcsolat ellenőrzéséhez. Nem jön létre semmi: megkapod a várható állapotot és az ellenőrzések eredményét.

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

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

Ügyfélállapotok

• activeÉlő és szinkronizál.
• pendingA kapcsolat még nem működik, ezért semmi nem kerül publikálásra.
• reviewAz Anuto átnézi, mert ennek az új ügyfélnek az e-mail-címe már egy másik Anuto-fiókhoz tartozik.
• inactiveTe kikapcsoltad, vagy az Anuto eltávolította.

Hibák

A sikertelen hívások JSON-t adnak statusCode, code és message mezőkkel. A code alapján döntsd el a teendőt; a message emberi olvasásra szól.

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

Hívási korlátok

A korlát túllépésekor 429-es választ kapsz Retry-After fejléccel. Várj ennyi másodpercet, majd próbáld újra.