oneapi
Autentificare
Business v1 / Meta

Meta / starea modulului

Versiunea API-ului și starea modulului Firme.

GET
https://oneapi.ro/api/business/v1/meta

Parametri de interogare

Ruta nu acceptă parametri de interogare.

Cum se comportă

  • Versiunea API-ului Firme şi starea modulului. Acoperirea pe surse şi prospeţimea datelor sunt la /meta/acoperire, sursele la /meta/surse.

La ce folosește

  • Verificarea versiunii API-ului dintr-un client, la pornire.
  • Un test de disponibilitate în monitorizare.
  • Afişarea stării modulului într-o pagină de status.

Structura răspunsului

Toate câmpurile de mai jos sunt în data.

CâmpTipDescriere
modul string Modulul care a răspuns.
versiune string Versiunea API a modulului.
stare string Starea modulului (ex. activ) — nu a vreunei firme.

Exemple de răspuns

GEThttps://oneapi.ro/api/business/v1/meta
{
    "data": {
        "modul": "business",
        "versiune": "v1",
        "stare": "activ"
    },
    "meta": {
        "sursa": []
    }
}

Coduri de eroare

CodSlugCând apare
401neautentificatToken lipsă, invalid, expirat sau revocat.
403feature_indisponibilPlanul curent nu include funcţia de care ţine ruta.
422validareRuta nu primeşte parametri, în afară de lang: orice alt parametru dă 422, nu e ignorat.
429cota_depasitaCota lunară a planului a fost depăşită (vezi Retry-After).

Toate erorile au aceeași formă. eroare.cod e stabil și e cel după care trebuie să ramifici în cod — nu după textul din mesaj, care se poate schimba.

{
    "eroare": {
        "cod": "validare",
        "mesaj": "Ruta nu primeşte parametri, în afară de lang: orice alt parametru dă 422, nu e ignorat."
    }
}