Client Account :: PPH API Docs

Account

GET client

API Token required

read

Returns information about the client.

Query-Parameter

Feld	Datentyp	Beschreibung
contacts	boolean	Append client contacts.
hostings	boolean	Append client hostings.
tickets	boolean	Append client tickets.
domains	boolean	Append client domains.
transactions	boolean	Append client transactions.
invoices	boolean	Append client invoices.
orders	boolean	Append orders invoices.

curl -X GET \
-G 'https://api.pph.sh/client' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

{
    "data": {
        "id": 41003,
        "firstname": "Dennis",
        "lastname": "Ziolkowski",
        "full_name": "Dennis Ziolkowski",
        "email": "dezio1991@gmail.com",
        "company": "",
        "address1": "Kurpromenade 48",
        "address2": "",
        "postcode": "23743",
        "city": "Gr\u00f6mitz",
        "country": "DE",
        "phonenumber": "04562 7172656",
        "datecreated": "2020-06-26T22:00:00.000000Z",
        "lastlogin": "2023-02-02T22:32:41.000000Z",
        "credit": 5.02,
        "credit_on_open_invoices": 0,
        "currency": {
            "id": 1,
            "code": "EUR",
            "prefix": "",
            "suffix": "\u20ac",
            "format": 3,
            "rate": "1.00000",
            "default": 1
        },
        "projected_hosting_value": 5.34,
        "avatar": "https:\/\/www.gravatar.com\/avatar\/41d76aabf67b9b197ca5523541a909e7"
    }
}

Web interface login

GET client/webinterface

API Token required

read access_login

Returns a link for direct login to vionity. The link expires after 30 seconds.

Playground

curl -X GET \
-G 'https://api.pph.sh/client/webinterface' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

{
    "data": {
        "url": "https:\/\/vionity.de\/userlogin\/5ef7dc233c3194c7a85224b6311670c5\/08ca998144914f4899c83c72c346a8f1?m=dezio1991%40gmail.com&h=c153774bf9e8aba4c2025001fffbd71f&t=1675377480&v=eyJpdiI6IjFoR05iMStwZjhBZ2RuQUNQV0cweUE9PSIsInZhbHVlIjoiYjVLQUhiOXlTZjl3TzZDbndrcFpEdz09IiwibWFjIjoiNjY0M2FjZWIwOTFhMzkyNzA2OGRlNTJmNDE5MWYxOGE1OTEwOGQyMzFkOWJjOGYwMzA0ZjlmMGQ4OWJjMWEzMiIsInRhZyI6IiJ9"
    }
}

Update account

POST client

API Token required

read

Update client account information. Be aware: All changes are logged internally. Fields labelled with "May be required" are required when the client has an active domain.

Changing the email address is not possible via api. Consult support when required.

Playground

Body-Parameter

Feld	Datentyp	Beschreibung
firstname	string	Your first name. Example: John required
lastname	string	May be required. Example: Doe
company	string	Company name.
address	string	May be required.
postcode	string	May be required.
city	string	May be required.
country	string	Country code as specified in ISO 3166-1 (Alpha-2 Code) ▶ https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes. Example: de required
phonenumber	string	May be required. Format: 0123 456789. Example: 0123 456789
newsletter	boolean	Whether to receive newsletter. Example: true

curl -X POST \
-G 'https://api.pph.sh/client' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

Contact details

GET client/contact

API Token required

read

Returns only the contact details for a client.

Playground

curl -X GET \
-G 'https://api.pph.sh/client/contact' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

{
    "data": {
        "firstname": "Dennis",
        "lastname": "Ziolkowski",
        "companyname": "",
        "email": "dezio1991@gmail.com",
        "address1": "Kurpromenade 48",
        "address2": "",
        "postcode": "23743",
        "city": "Gr\u00f6mitz",
        "country": "DE",
        "phonenumber": "04562 7172656",
        "validation": true
    }
}

Short summary

GET client/summary

API Token required

read

Returns a short summary about the client.

Playground

Response-Params

Feld	Datentyp	Beschreibung
credit	float	Available credit.
hostings	int	Number of active hostings.
domains	int	Number of active domains.
support	int	Number of active support requests.
invoices	int	Number of unpaid invoices.

curl -X GET \
-G 'https://api.pph.sh/client/summary' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

{
    "data": {
        "credit": 5.02,
        "hostings": 3,
        "domains": 1,
        "support": 0,
        "invoices": 1
    }
}

Available credit actions

GET client/credit/actions

read

Returns a list of available actions for available credit

Playground

curl -X GET \
-G 'https://api.pph.sh/client/credit/actions' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq

{
    "data": {
        "credit": 5.02,
        "actions": [
            {
                "invoice": 218983,
                "amount": 3.3,
                "type": "extend",
                "hostings": [
                    []
                ],
                "domains": []
            }
        ],
        "others": [],
        "missing_credit": 0
    }
}