Klientų kūrimas per API

Kliento sukūrimas per API

PHP pavyzdys su kopijavimu. Laukų tipai ir galimos reikšmės paaiškinti žemiau.

POSThttps://www.saskaitos.lt/apitype: customer

1$config = [2    'apiKey'    => 'JUSU_API_RAKTAS',3    'companyId' => 1,4];5 6$customerParams = [7    'type'   => 'customer',8    'action' => 'create',9    'Customer' => [10        'Name'     => 'Vardas',11        'Surename' => 'Pavarde',12        'Address'  => 'Ukmerges g., Vilnius',13        'Phone'    => '+3706XXXXXXX',14        'Email'    => '[email protected]',15        'Bank' => [16            'Account' => 'LT1234567890',17        ],18        'Company' => [19            'Name' => 'UAB "Imones pavadinimas"',20            'Code' => 'LT123456',21            'Tax'  => '123456',22        ],23        'Test' => '1',24    ],25];26 27$respondCustomer = json_decode(UseCURLSocket(28    'https://www.saskaitos.lt/api',29    array_merge($config, $customerParams)30));

$config = [
    'apiKey'    => 'JUSU_API_RAKTAS',
    'companyId' => 1,
];

$customerParams = [
    'type'   => 'customer',
    'action' => 'create',
    'Customer' => [
        'Name'     => 'Vardas',
        'Surename' => 'Pavarde',
        'Address'  => 'Ukmerges g., Vilnius',
        'Phone'    => '+3706XXXXXXX',
        'Email'    => 'el.pastas@example.com',
        'Bank' => [
            'Account' => 'LT1234567890',
        ],
        'Company' => [
            'Name' => 'UAB "Imones pavadinimas"',
            'Code' => 'LT123456',
            'Tax'  => '123456',
        ],
        'Test' => '1',
    ],
];

$respondCustomer = json_decode(UseCURLSocket(
    'https://www.saskaitos.lt/api',
    array_merge($config, $customerParams)
));

POST · formos duomenysJSON atsakymas

Pavyzdyje naudojama UseCURLSocket() funkcija. Jos aprašymas yra pilname PHP API pavyzdyje.

LAUKŲ ŽINYNAS

Laukai, tipai ir galimos reikšmės

Žemiau – šio PHP pavyzdžio parametrai ir paaiškinimas, ką juose perduoti.

stringTekstas, pvz. vardas ar įmonės kodas.

intSkaitinis ID, pavyzdyje sveikasis skaičius.

arraySusijusių laukų arba reikšmių masyvas.

PHP masyvai perduodami POST formos laukais, pvz. Customer[Email]. Užklausos reikšmės perduodamos tekstu, atsakymas grąžinamas JSON.

apiKeystring

Jūsų veiklos API raktas.

Bent 10 simbolių. Naudokite savo veiklos nustatymuose esantį raktą.

'JUSU_API_RAKTAS'Privalomas

companyIdint

Veiklos, kurios vardu atliekate veiksmą, numeris.

Teigiamas veiklos ID, pavyzdyje 1.

1Privalomas

typestring

Nurodo API duomenų sritį.

Šiame klientų pavyzdyje: 'customer'. Kitos API sritys: 'bill', 'company', 'test'; jų veiksmai skiriasi.

'customer'Šiame pavyzdyje

actionstring

Pasirenkamas veiksmas su klientu.

'search' · 'get' · 'create' · 'update' · 'delete'

'create'Pasirinkite veiksmą

Customerarray

Asociatyvus kliento duomenų masyvas.

Viduje pateikiami pasirinktam veiksmui reikalingi laukai.

[...]Duomenų grupė

ID kitam veiksmui

Customer.IDint

Jau išsaugoto kliento numeris.

Teigiamas kliento ID. Reikia get, update ir delete; kuriant naują klientą nesiunčiamas.

123Pagal veiksmą

Customer.Namestring

Fizinio asmens vardas.

Kuriant ar atnaujinant pateikite vardą arba įmonės pavadinimą. Jei abu tušti, naudojamas pateiktas el. paštas.

'Vardas'Vardas arba įmonė

Customer.Surenamestring

Fizinio asmens pavardė.

Tekstas. API lauko pavadinimą rašykite tiksliai Surename.

'Pavarde'Papildomas

Customer.Addressstring

Kliento adresas.

Laisvas adresą nusakantis tekstas.

'Ukmerges g., Vilnius'Papildomas

Customer.Phonestring

Kliento telefono numeris.

Perduokite tekstu, kad išliktų + ir pradžios nuliai.

'+3706XXXXXXX'Papildomas

Customer.Emailstring

Kliento el. pašto adresas.

Tekstinė reikšmė, pvz. [email protected]. Gali būti naudojamas search kriterijui.

'[email protected]'Papildomas / paieškai

Customer.Bankarray

Banko duomenų grupė.

Asociatyvus masyvas su Account lauku.

[...]Duomenų grupė

Customer.Bank.Accountstring

Kliento banko sąskaita.

Tekstinė banko sąskaitos reikšmė; pateiktas numeris yra demonstracinis.

'LT1234567890'Papildomas

Customer.Companyarray

Kliento įmonės rekvizitų grupė.

Asociatyvus masyvas su Name, Code ir Tax laukais.

[...]Duomenų grupė

Customer.Company.Namestring

Kliento įmonės pavadinimas.

Įmonės pavadinimas gali būti pateikiamas vietoje fizinio asmens vardo.

'UAB "Imones pavadinimas"'Vardas arba įmonė

Customer.Company.Codestring

Įmonės kodas.

Perduokite tekstu, kad išliktų pradžios nuliai.

'LT123456'Papildomas

Customer.Company.Taxstring

PVM mokėtojo kodas.

Tekstinė reikšmė. Jei PVM kodo nėra, reikšmė gali būti tuščia.

'123456'Papildomas

Customer.Teststring

Kliento įrašo žyma.

Pavyzdyje '1'. Tai nėra užklausos imitacija: laukas nesustabdo duomenų išsaugojimo. Griežtas bool ar 0/1 sąrašas čia neapibrėžtas.

'1'Žyma, ne dry run

Galimos action reikšmės

createSukurti klientą

Pateikite vardą arba įmonės pavadinimą. Jei abu tušti, naudojamas pateiktas el. paštas.

getGauti klientą

Pateikite jau išsaugoto kliento Customer.ID.

searchRasti klientą

Pateikite bent vieną kriterijų, pvz. Customer.Email. Grąžinamas vienas naujausias atitikmuo.

updateAtnaujinti klientą

Pateikite Customer.ID ir visus išsaugomus laukus. Praleistos reikšmės gali būti išvalytos arba pakeistos pradinėmis.

deleteIštrinti klientą

Pateikite kliento, kurį norite pašalinti, Customer.ID.

Paieškai naudojami plokšti įmonės ir banko laukai: Customer.CompanyName, Customer.CompanyCode, Customer.CompanyTax, Customer.BankAccount. Kuriant ir atnaujinant naudojamos aukščiau parodytos įdėtos grupės.

Kiti palaikomi kliento laukai

Customer.PersonCodestring

Asmens kodas.

Customer.Countrystring

Šalies kodas, pvz. 'lt' ar 'lv'. Paverčiamas mažosiomis raidėmis; tuščiam naudojama 'lt'.

Customer.Company.TaxClassificationstring

PVM klasifikatoriaus kodas.

Customer.ContractNumberstring

Sutarties numeris.

Customer.CertificateNumberstring

Sertifikato numeris.

Customer.PayInDaysstring

Apmokėjimo terminas dienomis, pvz. '14'.

Klientai

Kliento sukūrimas per API

Laukai, tipai ir galimos reikšmės

Galimos action reikšmės

Sąskaita klientui greičiau ir tvarkingiau