ISPadmin REST API

Share
14. 03. 2019
  • Základní URL: https://dev.ispadmin.eu/api/v1/

V hlavičce http požadavku musí být uveden token.

Token: 607897a17d6d18910a035ccea7b068c444a4d548d9cca721a735dac4efe709e0f3518373

Přidání klienta

Vytvoří nového klienta a přidělení klientského číslo. Vrátí json data z informacemi klienta.

  • URL

    /clients

  • Metoda

    POST

  • Parametry

JSON string v body požadavku.

{ "name": "[string]", "company": "[string]", "statusId": "[int]", "groupId": "[int]", "billingGroupId": "[int]", "email": "[string]", "www": "[string]", "nationalIdNumber": "[string]", "billingEmail": "[string]", "technicalEmail": "[string]", "businessEmail": "[string]", "telephone": "[string]", "mobilephone": "[string]", "accountNumber": "[string]", "bankNumber": "[string]", "iban": "[string]", "idCardNumber": "[string]", "address": { "street": "[string]", "buildingNumber": "[string]", "city": "[string]", "zip": "[string]", "county": "[string]", "state": "[string]" }, "billingAddress": { "nameLine1": "[string]", "nameLine2": "[string]", "street": "[string]", "city": "[string]", "zip": "[string]", "state": "[string]" }, "companyId": "[string]", "vatId": "[string]", "paymentTypeId": "[int]", "sendInvoicesByPost": "[bool]", "sendInvoiceByEmail": "[bool]", "issueDateByInvoicingDate": "[bool]", "invoiceDay": "[bool]", "invoiceDueDate": "[int]", "suspendOverdue": "[bool]", "issueProformaInvoices": "[bool]", "sendReminders": "[bool]", "internalNote1": "[string]" }

Povinné:

{ "name": "[string]", "statusId": "[int]", "groupId": "[int]", "billingGroupId": "[int]" }
  • Odpověď:

    • Kód: 200
      Obsah:
      { "id": "[int]", "name": "[string]", "clientNumber": "[string]", "balance": "[float]" }
  • Chybová odpověď:

    • Code: 400 BAD REQUEST
      Content: { error : "Bad account number." }
    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }
{ "errorMsg": "" }

Klient

Vrátí json data z informacemi klienta.

  • URL

    /clients/:clientId

  • Metoda

    GET

  • URL parametry

    Povinné:

    clientId = [integer]

  • Odpověď

    • Kód: 200
      Obsah:
      { "id": "[int]", "name": "[string]", "clientNumber": "[string]", "balance": "[float]" }
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

    • Code: 404 NOT FOUND
      Content: { error : "Client doesn't exist." }

Služby klienta

Vrátí json data se seznamem (aktivních) služeb klienta.

  • URL

    /clients/:clientId/services

  • Metoda

    GET

  • URL parametry

    Povinné:

    clientId = [integer]

  • Odpověď:

    • Kód: 200
      Obsah:

      [ { "id": "[int]", "name": "[string]", "type": "[string]" } ]

      type: internet, catv, dvbc, voip, mobile, universal, iptv

  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

    • Code: 404 NOT FOUND
      Content: { error : "Client doesn't exist." }

Fakturační skupiny

Vrátí json data se seznamem fakturačních skupin.

  • URL

    /billing-groups

  • Metoda

    GET

  • Odpověď:

    • Kód: 200
      Obsah:
      [ { "id": "[int]", "name": "[string]" } ]
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

Skupiny klientů

Vrátí json data se seznamem skupin klientů.

  • URL

    /client-groups

  • Metoda

    GET

  • Odpověď:

    • Kód: 200
      Obsah:
      [ { "id": "[int]", "name": "[string]", "color": "[string]" } ]
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

Stavy klientů

Vrátí json data se seznamem stavů klientů.

  • URL

    /client-statuses

  • Metoda

    GET

  • Odpověď:

    • Kód: 200
      Obsah:
      [ { "id": "[int]", "name": "[string]", "color": "[string]" } ]
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

Typy úhrad

Vrátí json data se seznamem typů úhrad.

  • URL

    /payment-types

  • Metoda

    GET

  • Odpověď:

    • Kód: 200
      Obsah:
      [ { "id": "[int]", "name": "[string]" } ]
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

Faktura

Vrátí json data s informací o uhrazení faktury.

  • URL

    /invoices/:invoiceId

  • Metoda

    GET

    • URL parametry

      Povinné:

      invoiceId = [integer] ID faktury

    • Odpověď

      • Kód: 200
        Obsah:
      { "id": "[int]", "settled": "[bool]" }
    • Chybová odpověď:

      • Code: 401 UNAUTHORIZED
        Content: { error : "Add token into header" }

      • Code: 404 NOT FOUND
        Content: { error : "Invoice doesn't exist." }

Vystavení nové faktury

Vytvoří novou fakturu ve fakturační skupině klienta. VS pokračuje v číselné řadě.

  • URL

    /invoices

  • Metoda

    POST

  • Parametry

JSON string v body požadavku.

{ "clientId": [int], "issueDate": "2019-02-25", "taxableDate": "2019-02-25", "items": [ { "invoicedFrom" : "2019-02-20", "invoicedTo" : "2019-02-22", "title": [string], "quantity" : [float], "unit" : [string], "pricePerUnit" : [float], "accountingName" : [string], "accountingNumber" : [string] } ] } `pricePerUnit` Je s DPH nebo bez DPH, podle nastavení ISPadmina. `accountingName` Předkontace `accountingNumber` Analytické číslo účtu
  • Odpověď

  • Kód: 201

{ "id": "[int]", "settled": ["bool"] }
  • Chybová odpověď:

  • Code: 401 UNAUTHORIZED
    Content: { error : "Add token into header" }

  • Code: 400 BAD REQUEST
    Content: { error : "Error description." }

Administrátoři

Vrátí json data s informacemi o administrátorech.

  • URL

    /users

  • Metoda

    GET

    • Odpověď

      • Kód: 200
        Obsah:
      [ { "id": "[int]", "username": "[string]", "name": "[string]", "email": "[string]", "phone": "[string]", "description": "[string]", "group": "[int]" } ]
    • Chybová odpověď:

      • Code: 401 UNAUTHORIZED
        Content: { error : "Add token into header" }

Vytvoření kopie administrátora

Přidá administrátora, nastaví oprávnění a povolené fakturační skupiny podle již existujícího administrátora a vrátí json data s informacemi o něm.

  • URL

    users

  • Metoda

    POST

  • Parametry

JSON string v body požadavku.

{ "createFromUserId": "[int]", "username": "[string]", "name": "[string]", "password": "[string]", "email": "[string]", "phone": "[string]", "description": "[string]" }
  • Odpověď

  • Kód: 201

{ "id": "[int]", "username": "[string]", "name": "[string]", "email": "[string]", "phone": "[string]", "description": "[string]", "group": "[int]" }

Administrátor

Vrátí json data s informacemi o administrátorovi.

  • URL

    /users/:userId

  • Metoda

    GET

  • URL parametry

    Povinné:

    userId = [int]

  • Odpověď

    • Kód: 200
      Obsah:
    [ { "id": "[int]", "username": "[string]", "name": "[string]", "email": "[string]", "phone": "[string]", "description": "[string]", "group": "[int]" } ]
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

    • Code: 404 NOT FOUND
      Content: { error : "User doesn't exist." }

Smazání administrátora

Smaže administrátora.

  • URL

    /users/:userId

  • Metoda

    DELETE

  • URL parametry

    Povinné:

    userId = [integer] ID administrátora

  • Odpověď

    • Kód: 204
  • Chybová odpověď:

    • Code: 401 UNAUTHORIZED
      Content: { error : "Add token into header" }

    • Code: 400 BAD REQUEST
      Content: { error : "Error description." }

Pomohl Vám tento článek?