Při integraci ABRA Flexi přes API může nastat potřeba připojit firmu do instance (zpřístupnit ji uživatelům) nebo ji naopak odpojit (skrýt, deaktivovat). K tomu slouží speciální endpointy /c/ a /c-all/.
Kdy použít /c/ a kdy /c-all/?
/c/– pracuje pouze s připojenými firmami./c-all/– umožňuje upravovat i odpojené firmy.
→ Pokud tedy firmu potřebujete připojit nebo odpojit, vždy používejte /c-all/.
Připojení/odpojení firmy
URL
{instance}/c(-all)/{firma}Podporované metody: PUT nebo POST
JSON
{
"show":true,
"name":"název firmy v Centrální databázi",
"licenseGroup":"id_licencni_skupiny"
}
XML
<companyInfo>
<show>true</show>
<name>Název firmy</name>
<licenseGroup>id_licencni_skupiny</licenseGroup>
</companyInfo>
Co jednotlivé hodnoty znamenají?
Klíč | Popis |
show |
|
name | Libovolný název, který se zobrazí v centrální databázi. |
licenseGroup | ID licenční skupiny, pod kterou firma běží. |
Příklady
Připojení firmy
Chci, aby byla firma dostupná ve výběru firem.
PUT/POST {instance}/c-all/{firma}
{
"show":true,
"name":"Moje firma s.r.o.",
"licenseGroup":"premium"
}
Odpojení firmy
Firma zůstane v databázi, ale nebude vidět ve výběru firem.
PUT/POST {instance}/c-all/{firma}
{
"show":false
}
Shrnutí
Pro manipulaci s firmami v Centrální databázi používejte endpoint
/c-all/, protože pracuje i s odpojenými firmami.Připojení/odpojení firmy provedete jednoduše nastavením hodnoty
show.Podporovány jsou formáty JSON i XML.